DirectPayment Class

Properties   Methods   Events   Config Settings   Errors  

Obtain payment through PayPal directly from a buyer's credit card.

Syntax

DirectPayment

Remarks

The DirectPayment class allows you to obtain payment for buyers who do not have a PayPal account. DirectPayment allows you to use your PayPal account as a gateway for any credit card. Your buyer no longer needs to have his own PayPal account.

At the time of this writing, in order to use this class you must have a PayPal Business account to accept direct payments, and you must apply to have "Website Payments Pro" activated on your account. Once that is accomplished and you have set up API access, accepting credit cards is simple. First set the User to your API name, and Password to the password for that API. Set the Signature property to the API signature you received from PayPal. Then you may set the transaction properties, such as : OrderTotal, CardNumber, CardExpMonth, CardExpYear, etc. Then call either Sale or Authorize. The Ack property will indicate the success or failure of the transaction.

After an authorization, the ResponseTransactionId should be saved and logged. This value may be used to capture or void any previous uncompleted Authorize transactions (these functions will not work for a Sale transaction, which is already considered complete).

In addition, this class also provides the results to two anti-fraud measures: Address Verification Service (AVS) and Card Verification Value (CVV) tests. The results of these tests will be stored in the ResponseAVS and ResponseCVV, respectively. Although a transaction may be authorized, it is up to the merchant to inspect these properties and determine whether or not to honor the transaction.

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.

Ack Property (DirectPayment Class)

Acknowledgement code received from PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAck();

Unicode (Windows)
LPWSTR GetAck();

char* inpay_directpayment_getack(void* lpObj);

QString GetAck();

Default Value

""

Remarks

This property will contain the acknowledgement code returned by PayPal that indicates the status of the transaction. It may contain one of the following values:

This property is read-only.

Data Type

String

CardType Property (DirectPayment Class)

This property specifies the type of the credit card specified in Number .

Syntax

• C++
• C
• Qt

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

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

CC_VISA(0), 
CC_MASTER_CARD(1), 
CC_DISCOVER(2), 
CC_AMEX(3), 
CC_SWITCH(4), 
CC_SOLO(5)

int inpay_directpayment_getcardtype(void* lpObj);
int inpay_directpayment_setcardtype(void* lpObj, int iCardType);

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

Default Value

0

Remarks

This property specifies the type of the credit card specified in CardNumber.

This property contains the type of the credit card (Visa, MasterCard, Amex, etc.) specified during the current transaction.

The valid card types for this property are listed below:

* Note: CurrencyCode must equal "GBP" to use this CardType. You may set the StartMonth, StartYear, and IssueNumber required for these cards via the Config method.

This property is required.

This property is not available at design time.

Data Type

Integer

CardCVV Property (DirectPayment Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardCVV();
int SetCardCVV(const char* lpszCardCVV);

Unicode (Windows)
LPWSTR GetCardCVV();
INT SetCardCVV(LPCWSTR lpszCardCVV);

char* inpay_directpayment_getcardcvv(void* lpObj);
int inpay_directpayment_setcardcvv(void* lpObj, const char* lpszCardCVV);

QString GetCardCVV();
int SetCardCVV(QString qsCardCVV);

Default Value

""

Remarks

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

This alphanumeric field 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 field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVV data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the field and decide whether to honor the transaction or not.

Character length and limitations: Up to four single-byte numeric characters.

This property is optional.

This property is not available at design time.

Data Type

String

CardExpMonth Property (DirectPayment Class)

This property contains the expiration month of the customer's credit card.

Syntax

• C++
• C
• Qt

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

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

int inpay_directpayment_getcardexpmonth(void* lpObj);
int inpay_directpayment_setcardexpmonth(void* lpObj, int iCardExpMonth);

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

Default Value

1

Remarks

This field contains the expiration month of the customer's credit card.

The valid range for this property is between 1 and 12.

This property is required.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DirectPayment Class)

This property contains the 4 digit expiration year of the customer's credit card.

Syntax

• C++
• C
• Qt

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

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

int inpay_directpayment_getcardexpyear(void* lpObj);
int inpay_directpayment_setcardexpyear(void* lpObj, int iCardExpYear);

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

Default Value

2000

Remarks

This field contains the 4 digit expiration year of the customer's credit card.

This property is required.

This property is not available at design time.

Data Type

Integer

CardNumber Property (DirectPayment Class)

This property contains the customer's credit card number for this 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_directpayment_getcardnumber(void* lpObj);
int inpay_directpayment_setcardnumber(void* lpObj, const char* lpszCardNumber);

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

Default Value

""

Remarks

This field contains the customer's credit card number for this transaction.

Character length and limitations: numeric characters only - no spaces, dashes or punctuation. Must conform with modulo and length required by each credit card type.

This property is required.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (DirectPayment Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int inpay_directpayment_getfirewallautodetect(void* lpObj);
int inpay_directpayment_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (DirectPayment Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int inpay_directpayment_getfirewalltype(void* lpObj);
int inpay_directpayment_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (DirectPayment Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* inpay_directpayment_getfirewallhost(void* lpObj);
int inpay_directpayment_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (DirectPayment Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* inpay_directpayment_getfirewallpassword(void* lpObj);
int inpay_directpayment_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (DirectPayment Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int inpay_directpayment_getfirewallport(void* lpObj);
int inpay_directpayment_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (DirectPayment Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* inpay_directpayment_getfirewalluser(void* lpObj);
int inpay_directpayment_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (DirectPayment Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int inpay_directpayment_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

InvoiceNumber Property (DirectPayment Class)

Your own invoice or 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* inpay_directpayment_getinvoicenumber(void* lpObj);
int inpay_directpayment_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

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

Default Value

""

Remarks

Character length and limitations: 127 single-byte alphanumeric characters.

This property is optional.

Data Type

String

ItemCount Property (DirectPayment Class)

The number of records in the Item arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemCount();
int SetItemCount(int iItemCount);

Unicode (Windows)
INT GetItemCount();
INT SetItemCount(INT iItemCount);

int inpay_directpayment_getitemcount(void* lpObj);
int inpay_directpayment_setitemcount(void* lpObj, int iItemCount);

int GetItemCount();
int SetItemCount(int iItemCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemAmount
• ItemDescription
• ItemName
• ItemNumber
• ItemOptions
• ItemQuantity
• ItemSalesTax

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

This property is not available at design time.

Data Type

Integer

ItemAmount Property (DirectPayment Class)

Amount of charged on payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemAmount(int iItemIndex);
int SetItemAmount(int iItemIndex, const char* lpszItemAmount);

Unicode (Windows)
LPWSTR GetItemAmount(INT iItemIndex);
INT SetItemAmount(INT iItemIndex, LPCWSTR lpszItemAmount);

char* inpay_directpayment_getitemamount(void* lpObj, int itemindex);
int inpay_directpayment_setitemamount(void* lpObj, int itemindex, const char* lpszItemAmount);

QString GetItemAmount(int iItemIndex);
int SetItemAmount(int iItemIndex, QString qsItemAmount);

Default Value

""

Remarks

Amount of charged on payment. It must have 2 decimal places, the decimal separator must be a period (.). An example Amount is "1010.10".

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (DirectPayment Class)

Paypal item description for the shopping cart.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, const char* lpszItemDescription);

Unicode (Windows)
LPWSTR GetItemDescription(INT iItemIndex);
INT SetItemDescription(INT iItemIndex, LPCWSTR lpszItemDescription);

char* inpay_directpayment_getitemdescription(void* lpObj, int itemindex);
int inpay_directpayment_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

Default Value

""

Remarks

Paypal item description for the shopping cart.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemName Property (DirectPayment Class)

Name of the item purchased.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, const char* lpszItemName);

Unicode (Windows)
LPWSTR GetItemName(INT iItemIndex);
INT SetItemName(INT iItemIndex, LPCWSTR lpszItemName);

char* inpay_directpayment_getitemname(void* lpObj, int itemindex);
int inpay_directpayment_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

QString GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, QString qsItemName);

Default Value

""

Remarks

Name of the item purchased.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemNumber Property (DirectPayment Class)

Item number set by the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemNumber(int iItemIndex);
int SetItemNumber(int iItemIndex, const char* lpszItemNumber);

Unicode (Windows)
LPWSTR GetItemNumber(INT iItemIndex);
INT SetItemNumber(INT iItemIndex, LPCWSTR lpszItemNumber);

char* inpay_directpayment_getitemnumber(void* lpObj, int itemindex);
int inpay_directpayment_setitemnumber(void* lpObj, int itemindex, const char* lpszItemNumber);

QString GetItemNumber(int iItemIndex);
int SetItemNumber(int iItemIndex, QString qsItemNumber);

Default Value

""

Remarks

Item number set by the merchant.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemOptions Property (DirectPayment Class)

Paypal item options for the shopping cart.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemOptions(int iItemIndex);
int SetItemOptions(int iItemIndex, const char* lpszItemOptions);

Unicode (Windows)
LPWSTR GetItemOptions(INT iItemIndex);
INT SetItemOptions(INT iItemIndex, LPCWSTR lpszItemOptions);

char* inpay_directpayment_getitemoptions(void* lpObj, int itemindex);
int inpay_directpayment_setitemoptions(void* lpObj, int itemindex, const char* lpszItemOptions);

QString GetItemOptions(int iItemIndex);
int SetItemOptions(int iItemIndex, QString qsItemOptions);

Default Value

""

Remarks

Paypal item options for the shopping cart.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemQuantity Property (DirectPayment Class)

Quantity of items ordered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, int iItemQuantity);

Unicode (Windows)
INT GetItemQuantity(INT iItemIndex);
INT SetItemQuantity(INT iItemIndex, INT iItemQuantity);

int inpay_directpayment_getitemquantity(void* lpObj, int itemindex);
int inpay_directpayment_setitemquantity(void* lpObj, int itemindex, int iItemQuantity);

int GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, int iItemQuantity);

Default Value

0

Remarks

Quantity of items ordered.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Integer

ItemSalesTax Property (DirectPayment Class)

Amount of tax charged on payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemSalesTax(int iItemIndex);
int SetItemSalesTax(int iItemIndex, const char* lpszItemSalesTax);

Unicode (Windows)
LPWSTR GetItemSalesTax(INT iItemIndex);
INT SetItemSalesTax(INT iItemIndex, LPCWSTR lpszItemSalesTax);

char* inpay_directpayment_getitemsalestax(void* lpObj, int itemindex);
int inpay_directpayment_setitemsalestax(void* lpObj, int itemindex, const char* lpszItemSalesTax);

QString GetItemSalesTax(int iItemIndex);
int SetItemSalesTax(int iItemIndex, QString qsItemSalesTax);

Default Value

""

Remarks

Amount of tax charged on payment.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTotal Property (DirectPayment Class)

Sum of all the Amount s.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTotal();
int SetItemTotal(const char* lpszItemTotal);

Unicode (Windows)
LPWSTR GetItemTotal();
INT SetItemTotal(LPCWSTR lpszItemTotal);

char* inpay_directpayment_getitemtotal(void* lpObj);
int inpay_directpayment_setitemtotal(void* lpObj, const char* lpszItemTotal);

QString GetItemTotal();
int SetItemTotal(QString qsItemTotal);

Default Value

""

Remarks

This property contains the sum cost of all items in this order, and may not contain any sales tax or shipping and handling charges.

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

MerchantSessionId Property (DirectPayment Class)

Your customer session identification token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantSessionId();
int SetMerchantSessionId(const char* lpszMerchantSessionId);

Unicode (Windows)
LPWSTR GetMerchantSessionId();
INT SetMerchantSessionId(LPCWSTR lpszMerchantSessionId);

char* inpay_directpayment_getmerchantsessionid(void* lpObj);
int inpay_directpayment_setmerchantsessionid(void* lpObj, const char* lpszMerchantSessionId);

QString GetMerchantSessionId();
int SetMerchantSessionId(QString qsMerchantSessionId);

Default Value

""

Remarks

PayPal records this optional session identification token as an additional means to detect possible fraud.

This property is optional.

Character length and limitations: 64 single-byte numeric characters.

Data Type

String

Note Property (DirectPayment Class)

An informational note about this settlement that will be displayed in the payer's transaction history.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNote();
int SetNote(const char* lpszNote);

Unicode (Windows)
LPWSTR GetNote();
INT SetNote(LPCWSTR lpszNote);

char* inpay_directpayment_getnote(void* lpObj);
int inpay_directpayment_setnote(void* lpObj, const char* lpszNote);

QString GetNote();
int SetNote(QString qsNote);

Default Value

""

Remarks

Used during Capture or VoidTransaction.

This property is optional.

Character length and limits: 255 single-byte characters.

Data Type

String

OrderDescription Property (DirectPayment Class)

Description of items the customer is purchasing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrderDescription();
int SetOrderDescription(const char* lpszOrderDescription);

Unicode (Windows)
LPWSTR GetOrderDescription();
INT SetOrderDescription(LPCWSTR lpszOrderDescription);

char* inpay_directpayment_getorderdescription(void* lpObj);
int inpay_directpayment_setorderdescription(void* lpObj, const char* lpszOrderDescription);

QString GetOrderDescription();
int SetOrderDescription(QString qsOrderDescription);

Default Value

""

Remarks

This property is optional.

Character length and limitations: 127 single-byte alphanumeric characters.

Data Type

String

OrderTotal Property (DirectPayment Class)

Total amount of the order.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrderTotal();
int SetOrderTotal(const char* lpszOrderTotal);

Unicode (Windows)
LPWSTR GetOrderTotal();
INT SetOrderTotal(LPCWSTR lpszOrderTotal);

char* inpay_directpayment_getordertotal(void* lpObj);
int inpay_directpayment_setordertotal(void* lpObj, const char* lpszOrderTotal);

QString GetOrderTotal();
int SetOrderTotal(QString qsOrderTotal);

Default Value

""

Remarks

This includes: sales tax applied (TaxTotal), shipping (ShippingTotal) and handling charges.

This property is required.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Password Property (DirectPayment Class)

Password for communicating with PayPal.

Syntax

• C++
• C
• Qt

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

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

char* inpay_directpayment_getpassword(void* lpObj);
int inpay_directpayment_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

This property is required to post messages to the PayPal URL. Do not confuse this property with your PayPal password. This password must match the API User you create from inside your PayPal account.

Data Type

String

PayerCity Property (DirectPayment Class)

Payer's city name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerCity();
int SetPayerCity(const char* lpszPayerCity);

Unicode (Windows)
LPWSTR GetPayerCity();
INT SetPayerCity(LPCWSTR lpszPayerCity);

char* inpay_directpayment_getpayercity(void* lpObj);
int inpay_directpayment_setpayercity(void* lpObj, const char* lpszPayerCity);

QString GetPayerCity();
int SetPayerCity(QString qsPayerCity);

Default Value

""

Remarks

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

Data Type

String

PayerCountryCode Property (DirectPayment Class)

Payer's country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerCountryCode();
int SetPayerCountryCode(const char* lpszPayerCountryCode);

Unicode (Windows)
LPWSTR GetPayerCountryCode();
INT SetPayerCountryCode(LPCWSTR lpszPayerCountryCode);

char* inpay_directpayment_getpayercountrycode(void* lpObj);
int inpay_directpayment_setpayercountrycode(void* lpObj, const char* lpszPayerCountryCode);

QString GetPayerCountryCode();
int SetPayerCountryCode(QString qsPayerCountryCode);

Default Value

"US"

Remarks

Payer's country code.

Payer's country of residence in the form of ISO standard 3166 two-character country codes.

This property is required.

Character limit: Two single-byte characters.

Data Type

String

PayerCountryName Property (DirectPayment Class)

Payer's country name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerCountryName();

Unicode (Windows)
LPWSTR GetPayerCountryName();

char* inpay_directpayment_getpayercountryname(void* lpObj);

QString GetPayerCountryName();

Default Value

"US"

Remarks

Payer's country name.

This property has been deprecated.

This property is read-only.

Data Type

String

PayerEmail Property (DirectPayment Class)

Email address of the payer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerEmail();
int SetPayerEmail(const char* lpszPayerEmail);

Unicode (Windows)
LPWSTR GetPayerEmail();
INT SetPayerEmail(LPCWSTR lpszPayerEmail);

char* inpay_directpayment_getpayeremail(void* lpObj);
int inpay_directpayment_setpayeremail(void* lpObj, const char* lpszPayerEmail);

QString GetPayerEmail();
int SetPayerEmail(QString qsPayerEmail);

Default Value

""

Remarks

Email address of the payer.

This property is optional.

Data Type

String

PayerFirstName Property (DirectPayment Class)

Payer's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerFirstName();
int SetPayerFirstName(const char* lpszPayerFirstName);

Unicode (Windows)
LPWSTR GetPayerFirstName();
INT SetPayerFirstName(LPCWSTR lpszPayerFirstName);

char* inpay_directpayment_getpayerfirstname(void* lpObj);
int inpay_directpayment_setpayerfirstname(void* lpObj, const char* lpszPayerFirstName);

QString GetPayerFirstName();
int SetPayerFirstName(QString qsPayerFirstName);

Default Value

""

Remarks

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

Data Type

String

PayerIPAddress Property (DirectPayment Class)

IP address of the payer's browser as recorded in its HTTP request to your website.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerIPAddress();
int SetPayerIPAddress(const char* lpszPayerIPAddress);

Unicode (Windows)
LPWSTR GetPayerIPAddress();
INT SetPayerIPAddress(LPCWSTR lpszPayerIPAddress);

char* inpay_directpayment_getpayeripaddress(void* lpObj);
int inpay_directpayment_setpayeripaddress(void* lpObj, const char* lpszPayerIPAddress);

QString GetPayerIPAddress();
int SetPayerIPAddress(QString qsPayerIPAddress);

Default Value

""

Remarks

IP address of the payer's browser as recorded in its HTTP request to your website.

Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.???

NOTE: PayPal records this IP address as a means to detect possible fraud.

This property is required.

Data Type

String

PayerLastName Property (DirectPayment Class)

Payer's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerLastName();
int SetPayerLastName(const char* lpszPayerLastName);

Unicode (Windows)
LPWSTR GetPayerLastName();
INT SetPayerLastName(LPCWSTR lpszPayerLastName);

char* inpay_directpayment_getpayerlastname(void* lpObj);
int inpay_directpayment_setpayerlastname(void* lpObj, const char* lpszPayerLastName);

QString GetPayerLastName();
int SetPayerLastName(QString qsPayerLastName);

Default Value

""

Remarks

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

Data Type

String

PayerState Property (DirectPayment Class)

Payer's state or province name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerState();
int SetPayerState(const char* lpszPayerState);

Unicode (Windows)
LPWSTR GetPayerState();
INT SetPayerState(LPCWSTR lpszPayerState);

char* inpay_directpayment_getpayerstate(void* lpObj);
int inpay_directpayment_setpayerstate(void* lpObj, const char* lpszPayerState);

QString GetPayerState();
int SetPayerState(QString qsPayerState);

Default Value

""

Remarks

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

Data Type

String

PayerStatus Property (DirectPayment Class)

Indicates whether the payer is verified or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerStatus();
int SetPayerStatus(const char* lpszPayerStatus);

Unicode (Windows)
LPWSTR GetPayerStatus();
INT SetPayerStatus(LPCWSTR lpszPayerStatus);

char* inpay_directpayment_getpayerstatus(void* lpObj);
int inpay_directpayment_setpayerstatus(void* lpObj, const char* lpszPayerStatus);

QString GetPayerStatus();
int SetPayerStatus(QString qsPayerStatus);

Default Value

""

Remarks

Indicates whether the payer is verified or not.

Valid values for this property are "verified" or "unverified".

Data Type

String

PayerStreet1 Property (DirectPayment Class)

Payer's street address (first line).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerStreet1();
int SetPayerStreet1(const char* lpszPayerStreet1);

Unicode (Windows)
LPWSTR GetPayerStreet1();
INT SetPayerStreet1(LPCWSTR lpszPayerStreet1);

char* inpay_directpayment_getpayerstreet1(void* lpObj);
int inpay_directpayment_setpayerstreet1(void* lpObj, const char* lpszPayerStreet1);

QString GetPayerStreet1();
int SetPayerStreet1(QString qsPayerStreet1);

Default Value

""

Remarks

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

Data Type

String

PayerStreet2 Property (DirectPayment Class)

Payer's street address (second line).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerStreet2();
int SetPayerStreet2(const char* lpszPayerStreet2);

Unicode (Windows)
LPWSTR GetPayerStreet2();
INT SetPayerStreet2(LPCWSTR lpszPayerStreet2);

char* inpay_directpayment_getpayerstreet2(void* lpObj);
int inpay_directpayment_setpayerstreet2(void* lpObj, const char* lpszPayerStreet2);

QString GetPayerStreet2();
int SetPayerStreet2(QString qsPayerStreet2);

Default Value

""

Remarks

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

Data Type

String

PayerZip Property (DirectPayment Class)

Payer's United States ZIP code or other country-specific postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerZip();
int SetPayerZip(const char* lpszPayerZip);

Unicode (Windows)
LPWSTR GetPayerZip();
INT SetPayerZip(LPCWSTR lpszPayerZip);

char* inpay_directpayment_getpayerzip(void* lpObj);
int inpay_directpayment_setpayerzip(void* lpObj, const char* lpszPayerZip);

QString GetPayerZip();
int SetPayerZip(QString qsPayerZip);

Default Value

""

Remarks

Payer's United States ZIP code or other country-specific postal code.

This property is required.

Character length and limitations: 20 single-byte characters.

Data Type

String

PaymentDate Property (DirectPayment Class)

This is the time/date stamp of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentDate();

Unicode (Windows)
LPWSTR GetPaymentDate();

char* inpay_directpayment_getpaymentdate(void* lpObj);

QString GetPaymentDate();

Default Value

""

Remarks

This is the time/date stamp of payment.

This property is read-only.

Data Type

String

PaymentExchangeRate Property (DirectPayment Class)

Exchange rate if a currency conversion occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentExchangeRate();

Unicode (Windows)
LPWSTR GetPaymentExchangeRate();

char* inpay_directpayment_getpaymentexchangerate(void* lpObj);

QString GetPaymentExchangeRate();

Default Value

""

Remarks

Exchange rate if a currency conversion occurred.

Relevant only if you are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer's account.

This property is read-only.

Data Type

String

PaymentFeeAmount Property (DirectPayment Class)

PayPal fee amount charged for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentFeeAmount();

Unicode (Windows)
LPWSTR GetPaymentFeeAmount();

char* inpay_directpayment_getpaymentfeeamount(void* lpObj);

QString GetPaymentFeeAmount();

Default Value

""

Remarks

PayPal fee amount charged for the transaction.

This property is read-only.

Data Type

String

PaymentGrossAmount Property (DirectPayment Class)

The final amount charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentGrossAmount();

Unicode (Windows)
LPWSTR GetPaymentGrossAmount();

char* inpay_directpayment_getpaymentgrossamount(void* lpObj);

QString GetPaymentGrossAmount();

Default Value

""

Remarks

The final amount charged.

This includes any shipping and taxes from your Merchant Profile.

This property is read-only.

Data Type

String

PaymentType Property (DirectPayment Class)

Indicates whether the payment is instant or delayed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentType();

Unicode (Windows)
LPWSTR GetPaymentType();

char* inpay_directpayment_getpaymenttype(void* lpObj);

QString GetPaymentType();

Default Value

""

Remarks

Indicates whether the payment is instant or delayed.

Current list of return values: none, echeck, instant.

This property is read-only.

Data Type

String

PaymentPendingReason Property (DirectPayment Class)

The reason the payment is pending.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentPendingReason();

Unicode (Windows)
LPWSTR GetPaymentPendingReason();

char* inpay_directpayment_getpaymentpendingreason(void* lpObj);

QString GetPaymentPendingReason();

Default Value

""

Remarks

The reason the payment is pending.

The current list of possible return values for this property are:

This property is read-only.

Data Type

String

PaymentSettleAmount Property (DirectPayment Class)

Amount deposited in your PayPal account after a currency conversion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentSettleAmount();

Unicode (Windows)
LPWSTR GetPaymentSettleAmount();

char* inpay_directpayment_getpaymentsettleamount(void* lpObj);

QString GetPaymentSettleAmount();

Default Value

""

Remarks

Amount deposited in your PayPal account after a currency conversion.

If there is no currency conversion, this property will remain empty.

This property is read-only.

Data Type

String

PaymentStatus Property (DirectPayment Class)

Status of the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentStatus();

Unicode (Windows)
LPWSTR GetPaymentStatus();

char* inpay_directpayment_getpaymentstatus(void* lpObj);

QString GetPaymentStatus();

Default Value

""

Remarks

Status of the payment.

The current list of possible values for this property are:

Note: When the returned value of this property is...

- "Canceled-Reversal": it means that a reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you.

- "Denied": this happens only if the payment was previously pending because of possible reasons described for the PendingReason element.

- "Failed": this happens only if the payment was made from your customer's bank account.

- "Pending": see the PaymentPendingReason field for more information.

This property is read-only.

Data Type

String

PaymentTaxAmount Property (DirectPayment Class)

Tax charged on the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTaxAmount();

Unicode (Windows)
LPWSTR GetPaymentTaxAmount();

char* inpay_directpayment_getpaymenttaxamount(void* lpObj);

QString GetPaymentTaxAmount();

Default Value

""

Remarks

Tax charged on the transaction.

This property is read-only.

Data Type

String

PaymentTransactionId Property (DirectPayment Class)

Unique transaction ID of the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTransactionId();

Unicode (Windows)
LPWSTR GetPaymentTransactionId();

char* inpay_directpayment_getpaymenttransactionid(void* lpObj);

QString GetPaymentTransactionId();

Default Value

""

Remarks

Unique transaction ID of the payment.

This property is read-only.

Data Type

String

PaymentTransactionType Property (DirectPayment Class)

The type of transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTransactionType();

Unicode (Windows)
LPWSTR GetPaymentTransactionType();

char* inpay_directpayment_getpaymenttransactiontype(void* lpObj);

QString GetPaymentTransactionType();

Default Value

""

Remarks

The type of transaction.

Current list of return values: cart, express-checkout.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (DirectPayment 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_directpayment_getproxyauthscheme(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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_directpayment_getproxyautodetect(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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_directpayment_getproxypassword(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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_directpayment_getproxyport(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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_directpayment_getproxyserver(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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_directpayment_getproxyssl(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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_directpayment_getproxyuser(void* lpObj);
int inpay_directpayment_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

ResponseAmount Property (DirectPayment Class)

Amount returned in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAmount();

Unicode (Windows)
LPWSTR GetResponseAmount();

char* inpay_directpayment_getresponseamount(void* lpObj);

QString GetResponseAmount();

Default Value

""

Remarks

Amount returned in the response.

This should always match the value sent in OrderTotal.

This property is read-only.

Data Type

String

ResponseAVS Property (DirectPayment Class)

The Address Verification System response code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVS();

Unicode (Windows)
LPWSTR GetResponseAVS();

char* inpay_directpayment_getresponseavs(void* lpObj);

QString GetResponseAVS();

Default Value

""

Remarks

The Address Verification System response code.

This one character field contains the Address Verification System (AVS) result code. This is always returned in the server response. The AVS service is used to help detect fraud. While PayPal may authorize a payment, it is up to the merchant to check the ResponseAVS and decide whether or not to honor the transaction.

The valid AVS codes are listed in the table below.

This property is read-only.

Data Type

String

ResponseCVV Property (DirectPayment Class)

Result of the CVV check by PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVV();

Unicode (Windows)
LPWSTR GetResponseCVV();

char* inpay_directpayment_getresponsecvv(void* lpObj);

QString GetResponseCVV();

Default Value

""

Remarks

Result of the CardCVV check by PayPal.

If a CVV value was present in the CardCVV property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. This is used to help detect fraud. It is up to the merchant to inspect this value and determine whether or not to honor the transaction.

The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseTransactionId Property (DirectPayment Class)

Unique Transaction Id of the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* inpay_directpayment_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Unique Transaction Id of the payment.

The value of this property is returned by the server when either one of the following methods is called:

- Sale. In this case, the ResponseTransactionId is your record of the transaction.

- Authorize. You will need the value of ResponseTransactionId for use as a key when capturing funds.

Character length and limitations:17 single-byte characters.

This property is read-only.

Data Type

String

ShippingTotal Property (DirectPayment Class)

Total shipping costs for this order.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingTotal();
int SetShippingTotal(const char* lpszShippingTotal);

Unicode (Windows)
LPWSTR GetShippingTotal();
INT SetShippingTotal(LPCWSTR lpszShippingTotal);

char* inpay_directpayment_getshippingtotal(void* lpObj);
int inpay_directpayment_setshippingtotal(void* lpObj, const char* lpszShippingTotal);

QString GetShippingTotal();
int SetShippingTotal(QString qsShippingTotal);

Default Value

""

Remarks

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Signature Property (DirectPayment Class)

Value to use with PayPal's Signature Authentication scheme.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignature();
int SetSignature(const char* lpszSignature);

Unicode (Windows)
LPWSTR GetSignature();
INT SetSignature(LPCWSTR lpszSignature);

char* inpay_directpayment_getsignature(void* lpObj);
int inpay_directpayment_setsignature(void* lpObj, const char* lpszSignature);

QString GetSignature();
int SetSignature(QString qsSignature);

Default Value

""

Remarks

A PayPal-generated unique digital signature (a line of text, or hash) that you copy from PayPal's website and include in API calls made by this class. An alternative to API Certificate security. Your digital signature, your API username, and your API password all together are called three-token authentication. An API signature is suitable for use with Microsoft Windows web servers or other shared web server configurations, such as those used by web hosting services. Multiple API signatures can be associated with your API username and password. For security, every time you view your API credential/signature on https://www.paypal.com, a new signature is generated. In your API calls, you can use any of the signatures that PayPal generates for you. All the signatures are equally valid until you remove your credentials by clicking Remove on the View API Signature page.

Data Type

String

SSLAcceptServerCertEncoded Property (DirectPayment 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 inpay_directpayment_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inpay_directpayment_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 (DirectPayment 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 inpay_directpayment_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inpay_directpayment_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 (DirectPayment 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 inpay_directpayment_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inpay_directpayment_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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DirectPayment 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* inpay_directpayment_getsslcertstorepassword(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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 inpay_directpayment_getsslcertstoretype(void* lpObj);
int inpay_directpayment_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 (DirectPayment 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* inpay_directpayment_getsslcertsubject(void* lpObj);
int inpay_directpayment_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 properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (DirectPayment 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 inpay_directpayment_getsslprovider(void* lpObj);
int inpay_directpayment_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:

Additional Notes

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 (DirectPayment 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 inpay_directpayment_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

TaxTotal Property (DirectPayment Class)

Sum of tax for all items included in this order.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxTotal();
int SetTaxTotal(const char* lpszTaxTotal);

Unicode (Windows)
LPWSTR GetTaxTotal();
INT SetTaxTotal(LPCWSTR lpszTaxTotal);

char* inpay_directpayment_gettaxtotal(void* lpObj);
int inpay_directpayment_settaxtotal(void* lpObj, const char* lpszTaxTotal);

QString GetTaxTotal();
int SetTaxTotal(QString qsTaxTotal);

Default Value

""

Remarks

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Timeout Property (DirectPayment 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 inpay_directpayment_gettimeout(void* lpObj);
int inpay_directpayment_settimeout(void* lpObj, int iTimeout);

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

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

URL Property (DirectPayment Class)

URL all PayPal payment transactions are posted to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* inpay_directpayment_geturl(void* lpObj);
int inpay_directpayment_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

Default Value

"https://api-3t.paypal.com/nvp"

Remarks

This is the URL to which the class posts requests to, and receives responses from. The server you use depends on whether you are using the "API Certificate" or the "API Signature" authentication scheme. If you use the API Certificate authentication scheme, you must set the SSLCert with your client-side certificate. If using the Signature method, set the Signature property instead. The list of valid URLs is shown below:

Data Type

String

User Property (DirectPayment Class)

User name for communicating with Paypal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* inpay_directpayment_getuser(void* lpObj);
int inpay_directpayment_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property is required to post messages to the PayPal URL. This should not be the same username as your PayPal account login, but rather the name of the API service you've created in your account. If you allow PayPal to auto-generate the name, it is usually the first part of your email address plus "_api1." plus the last part of your email address. For instance, a PayPal Id of test@teststore.com would generate a user name test_api1.teststore.com.

Data Type

String

AddCustomField Method (DirectPayment Class)

This adds a custom name-value pair to be sent with the next request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCustomField(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddCustomField(LPCWSTR lpszName, LPCWSTR lpszValue);

int inpay_directpayment_addcustomfield(void* lpObj, const char* lpszName, const char* lpszValue);

int AddCustomField(const QString& qsName, const QString& qsValue);

Remarks

This method should be used to append a custom name-value pair to the next outgoing request to PayPal.

Note: The custom fields that have been added will be cleared by the class automatically after each request.

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

Authorize Method (DirectPayment Class)

This method sends an Authorization transaction to PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int inpay_directpayment_authorize(void* lpObj);

int Authorize();

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account.

However, in the case of an authorization (using the Authorize method), funds are not automatically captured. You must manually capture the funds with the Capture method.

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

Capture Method (DirectPayment Class)

Completely or partially settles a previously authorized transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Capture(const char* lpszAuthorizationId, const char* lpszAmount);

Unicode (Windows)
INT Capture(LPCWSTR lpszAuthorizationId, LPCWSTR lpszAmount);

int inpay_directpayment_capture(void* lpObj, const char* lpszAuthorizationId, const char* lpszAmount);

int Capture(const QString& qsAuthorizationId, const QString& qsAmount);

Remarks

This method captures the transaction indicated by the AuthorizationId parameter for the amount specified in the Amount parameter. You may capture less than the authorized amount by setting the IsPartialCapture configuration setting to True.

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 (DirectPayment 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* inpay_directpayment_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.

DoEvents Method (DirectPayment Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int inpay_directpayment_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

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

GetResponseVar Method (DirectPayment Class)

It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseVar(const char* lpszName);

Unicode (Windows)
LPWSTR GetResponseVar(LPCWSTR lpszName);

char* inpay_directpayment_getresponsevar(void* lpObj, const char* lpszName);

QString GetResponseVar(const QString& qsName);

Remarks

This method allows you to retrieve additional variables from the response. The value is returned by the method. Note that the variable name is case-sensitive. component.GetResponseVar("ACK")

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 (DirectPayment Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int inpay_directpayment_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.)

Reset Method (DirectPayment Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inpay_directpayment_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values and returns the component to its default state.

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 (DirectPayment Class)

This method sends a Sale transaction to PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sale();

Unicode (Windows)
INT Sale();

int inpay_directpayment_sale(void* lpObj);

int Sale();

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account. However, in the case of an authorization (using the Authorize method), funds are not automatically captured. You must manually capture the funds with the Capture method.

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

VoidTransaction Method (DirectPayment Class)

Voids a prior authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VoidTransaction(const char* lpszAuthorizationId);

Unicode (Windows)
INT VoidTransaction(LPCWSTR lpszAuthorizationId);

int inpay_directpayment_voidtransaction(void* lpObj, const char* lpszAuthorizationId);

int VoidTransaction(const QString& qsAuthorizationId);

Remarks

This voids the transaction indicated by the AuthorizationId parameter.

Note: when the three-day authorization period expires, the authorization of a transaction is implicitly voided.

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 (DirectPayment Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DIRECTPAYMENT_ERROR 1

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

class DirectPaymentErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description 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 (DirectPayment Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DIRECTPAYMENT_SSLSERVERAUTHENTICATION 2

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

class DirectPaymentSSLServerAuthenticationEventParams {
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(DirectPaymentSSLServerAuthenticationEventParams *e);

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