ExpressCheckout Class

Properties   Methods   Events   Config Settings   Errors  

Express Checkout allows customers the option to quickly pay through PayPal.

Syntax

ExpressCheckout

Remarks

The ExpressCheckout class allows you to integrate PayPal payments into your application by redirecting customers to the PayPal site. During the ExpressCheckout process, a token is generated which encodes transaction details and is used to identify the transaction on the PayPal network. After fetching a token, the customer must be redirected to PayPal's website to fill out payment information. PayPal will then redirect the customer to the URL specified by the class's ReturnURL property. PayPal will append the token to this URL so that it can be accessed after both redirects are complete. This token should then be used to verify details about the payment and finalize the transaction.

The first step in this process is to use the SetCheckout method to fetch a token from PayPal. If the Ack property indicates that this is successful, you should append the ResponseToken value to PayPal's express checkout URL and redirect the customer there. Redirection is not handled automatically by the component and requires external implementation. After the customer pays on PayPal's site, the customer will be automatically returned to the ReturnURL. If the customer declines to pay, PayPal will redirect to the CancelURL instead. Both of these properties must be set prior to calling SetCheckout. All of the remaining steps in the ExpressCheckout process must then be performed on the page given by ReturnURL.

The following is an example of fetching a token and redirecting to PayPal's site. Note that the PayPal credentials and URL (User, Password, Signature, and URL) are also required before calling SetCheckout. expresscheckout1.OrderTotal = "88.88"; expresscheckout1.ReturnURL = "http://localhost/example/return/url"; expresscheckout1.CancelURL = "http://localhost/example/cancel/url"; expresscheckout1.PaymentAction = ExpresscheckoutPaymentActions.aSale; expresscheckout1.SetCheckout(); // Now check for success and redirect the buyer: if (expresscheckout1.Ack == "Success") { // Redirect is not a component method and should be implemented externally Redirect("https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=" + expresscheckout1.ResponseToken) }

The following steps should now take place on the page indicated by ReturnURL.

Next, the PayPal token must be retrieved. PayPal automatically appends the token to the specified ReturnURL, so this value should be parsed and set as the Token property. The PayPal credentials and URL (User, Password, Signature, and URL) should also be set if they have not already been. Next, GetCheckoutDetails should be called so that Payer and Payment properties are automatically populated. The PayerId property is required before finalizing the transaction, but you may also want to check other fields under the Payer and Payment properties to ensure they are correct.

Finally, if all transaction details are correct, the CheckoutPayment method should be called to finalize the payment. If PaymentAction is set to aSale, this will finalize the transaction and transfer funds to your PayPal account. If instead the PaymentAction is set to aAuthorization, you will need to capture the transaction later.

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

Acknowledgement code received from PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAck();

Unicode (Windows)
LPWSTR GetAck();

char* inpay_expresscheckout_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

BuyerEmail Property (ExpressCheckout Class)

Buyer's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBuyerEmail();
int SetBuyerEmail(const char* lpszBuyerEmail);

Unicode (Windows)
LPWSTR GetBuyerEmail();
INT SetBuyerEmail(LPCWSTR lpszBuyerEmail);

char* inpay_expresscheckout_getbuyeremail(void* lpObj);
int inpay_expresscheckout_setbuyeremail(void* lpObj, const char* lpszBuyerEmail);

QString GetBuyerEmail();
int SetBuyerEmail(QString qsBuyerEmail);

Default Value

""

Remarks

Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page.

This property is optional when calling the SetCheckout method.

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

Data Type

String

CancelURL Property (ExpressCheckout Class)

URL to which the customer is returned if he decides not to pay with PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCancelURL();
int SetCancelURL(const char* lpszCancelURL);

Unicode (Windows)
LPWSTR GetCancelURL();
INT SetCancelURL(LPCWSTR lpszCancelURL);

char* inpay_expresscheckout_getcancelurl(void* lpObj);
int inpay_expresscheckout_setcancelurl(void* lpObj, const char* lpszCancelURL);

QString GetCancelURL();
int SetCancelURL(QString qsCancelURL);

Default Value

""

Remarks

If the user starts to pay with PayPal, and then changes his mind, his browser will be redirected to this URL on your server. This may be set to the original page on which the customer chose his payment method.

This property is required when calling the SetCheckout method.

Character length and limitations: no limit. Must be URL-encoded.

Data Type

String

ContactPhone Property (ExpressCheckout Class)

Payer's contact telephone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContactPhone();

Unicode (Windows)
LPWSTR GetContactPhone();

char* inpay_expresscheckout_getcontactphone(void* lpObj);

QString GetContactPhone();

Default Value

""

Remarks

PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one.

This property is returned after a call to the GetCheckoutDetails method.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (ExpressCheckout 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_expresscheckout_getfirewallautodetect(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getfirewalltype(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getfirewallhost(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getfirewallpassword(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getfirewallport(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getfirewalluser(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int inpay_expresscheckout_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 (ExpressCheckout Class)

Your own unique 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_expresscheckout_getinvoicenumber(void* lpObj);
int inpay_expresscheckout_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

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

Default Value

""

Remarks

This property is optional when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

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

Data Type

String

ItemCount Property (ExpressCheckout 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_expresscheckout_getitemcount(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemamount(void* lpObj, int itemindex);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemdescription(void* lpObj, int itemindex);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemname(void* lpObj, int itemindex);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemnumber(void* lpObj, int itemindex);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemoptions(void* lpObj, int itemindex);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemquantity(void* lpObj, int itemindex);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getitemsalestax(void* lpObj, int itemindex);
int inpay_expresscheckout_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

Note Property (ExpressCheckout 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_expresscheckout_getnote(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getorderdescription(void* lpObj);
int inpay_expresscheckout_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.

This property is optional when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

Data Type

String

OrderTotal Property (ExpressCheckout Class)

The total cost of the order to the customer.

Syntax

• C++
• C
• Qt

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

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

char* inpay_expresscheckout_getordertotal(void* lpObj);
int inpay_expresscheckout_setordertotal(void* lpObj, const char* lpszOrderTotal);

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

Default Value

""

Remarks

If shipping cost and tax charges are known, those should included in the OrderTotal if not, the value of this property is the current sub-total of the order.

This property is required when calling the CheckoutPayment method.

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 (ExpressCheckout 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_expresscheckout_getpassword(void* lpObj);
int inpay_expresscheckout_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

PayerBusiness Property (ExpressCheckout Class)

Payer's business email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerBusiness();

Unicode (Windows)
LPWSTR GetPayerBusiness();

char* inpay_expresscheckout_getpayerbusiness(void* lpObj);

QString GetPayerBusiness();

Default Value

""

Remarks

Payer's business email address.

This property is read-only.

Data Type

String

PayerCity Property (ExpressCheckout Class)

Payer's city name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerCity();

Unicode (Windows)
LPWSTR GetPayerCity();

char* inpay_expresscheckout_getpayercity(void* lpObj);

QString GetPayerCity();

Default Value

""

Remarks

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

This property is read-only.

Data Type

String

PayerCountryCode Property (ExpressCheckout Class)

Payer's country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerCountryCode();

Unicode (Windows)
LPWSTR GetPayerCountryCode();

char* inpay_expresscheckout_getpayercountrycode(void* lpObj);

QString GetPayerCountryCode();

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.

This property is read-only.

Data Type

String

PayerEmail Property (ExpressCheckout Class)

Email address of the payer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerEmail();

Unicode (Windows)
LPWSTR GetPayerEmail();

char* inpay_expresscheckout_getpayeremail(void* lpObj);

QString GetPayerEmail();

Default Value

""

Remarks

Email address of the payer.

This property is optional.

This property is read-only.

Data Type

String

PayerFirstName Property (ExpressCheckout Class)

Payer's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerFirstName();

Unicode (Windows)
LPWSTR GetPayerFirstName();

char* inpay_expresscheckout_getpayerfirstname(void* lpObj);

QString GetPayerFirstName();

Default Value

""

Remarks

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

This property is read-only.

Data Type

String

PayerLastName Property (ExpressCheckout Class)

Payer's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerLastName();

Unicode (Windows)
LPWSTR GetPayerLastName();

char* inpay_expresscheckout_getpayerlastname(void* lpObj);

QString GetPayerLastName();

Default Value

""

Remarks

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

This property is read-only.

Data Type

String

PayerState Property (ExpressCheckout Class)

Payer's state or province name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerState();

Unicode (Windows)
LPWSTR GetPayerState();

char* inpay_expresscheckout_getpayerstate(void* lpObj);

QString GetPayerState();

Default Value

""

Remarks

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

This property is read-only.

Data Type

String

PayerStatus Property (ExpressCheckout Class)

Indicates whether the payer is verified or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerStatus();

Unicode (Windows)
LPWSTR GetPayerStatus();

char* inpay_expresscheckout_getpayerstatus(void* lpObj);

QString GetPayerStatus();

Default Value

""

Remarks

Indicates whether the payer is verified or not.

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

This property is read-only.

Data Type

String

PayerStreet1 Property (ExpressCheckout Class)

Payer's street address (first line).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerStreet1();

Unicode (Windows)
LPWSTR GetPayerStreet1();

char* inpay_expresscheckout_getpayerstreet1(void* lpObj);

QString GetPayerStreet1();

Default Value

""

Remarks

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

This property is read-only.

Data Type

String

PayerStreet2 Property (ExpressCheckout Class)

Payer's street address (second line).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerStreet2();

Unicode (Windows)
LPWSTR GetPayerStreet2();

char* inpay_expresscheckout_getpayerstreet2(void* lpObj);

QString GetPayerStreet2();

Default Value

""

Remarks

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

This property is read-only.

Data Type

String

PayerZip Property (ExpressCheckout Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerZip();

Unicode (Windows)
LPWSTR GetPayerZip();

char* inpay_expresscheckout_getpayerzip(void* lpObj);

QString GetPayerZip();

Default Value

""

Remarks

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

Character length and limitations: 20 single-byte characters.

This property is read-only.

Data Type

String

PayerId Property (ExpressCheckout Class)

Unique encrypted PayPal customer account number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayerId();
int SetPayerId(const char* lpszPayerId);

Unicode (Windows)
LPWSTR GetPayerId();
INT SetPayerId(LPCWSTR lpszPayerId);

char* inpay_expresscheckout_getpayerid(void* lpObj);
int inpay_expresscheckout_setpayerid(void* lpObj, const char* lpszPayerId);

QString GetPayerId();
int SetPayerId(QString qsPayerId);

Default Value

""

Remarks

This property is required when calling the CheckoutPayment method.

This property is returned after a call to the GetCheckoutDetails method.

Character length and limitations:17 single-byte characters maximum.

Data Type

String

PaymentDate Property (ExpressCheckout Class)

This is the time/date stamp of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentDate();

Unicode (Windows)
LPWSTR GetPaymentDate();

char* inpay_expresscheckout_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 (ExpressCheckout Class)

Exchange rate if a currency conversion occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentExchangeRate();

Unicode (Windows)
LPWSTR GetPaymentExchangeRate();

char* inpay_expresscheckout_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 (ExpressCheckout Class)

PayPal fee amount charged for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentFeeAmount();

Unicode (Windows)
LPWSTR GetPaymentFeeAmount();

char* inpay_expresscheckout_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 (ExpressCheckout Class)

The final amount charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentGrossAmount();

Unicode (Windows)
LPWSTR GetPaymentGrossAmount();

char* inpay_expresscheckout_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 (ExpressCheckout Class)

Indicates whether the payment is instant or delayed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentType();

Unicode (Windows)
LPWSTR GetPaymentType();

char* inpay_expresscheckout_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 (ExpressCheckout Class)

The reason the payment is pending.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentPendingReason();

Unicode (Windows)
LPWSTR GetPaymentPendingReason();

char* inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_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 (ExpressCheckout Class)

Status of the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentStatus();

Unicode (Windows)
LPWSTR GetPaymentStatus();

char* inpay_expresscheckout_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 (ExpressCheckout Class)

Tax charged on the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTaxAmount();

Unicode (Windows)
LPWSTR GetPaymentTaxAmount();

char* inpay_expresscheckout_getpaymenttaxamount(void* lpObj);

QString GetPaymentTaxAmount();

Default Value

""

Remarks

Tax charged on the transaction.

This property is read-only.

Data Type

String

PaymentTransactionId Property (ExpressCheckout Class)

Unique transaction ID of the payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTransactionId();

Unicode (Windows)
LPWSTR GetPaymentTransactionId();

char* inpay_expresscheckout_getpaymenttransactionid(void* lpObj);

QString GetPaymentTransactionId();

Default Value

""

Remarks

Unique transaction ID of the payment.

This property is read-only.

Data Type

String

PaymentTransactionType Property (ExpressCheckout Class)

The type of transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentTransactionType();

Unicode (Windows)
LPWSTR GetPaymentTransactionType();

char* inpay_expresscheckout_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

PaymentAction Property (ExpressCheckout Class)

How you want to obtain payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPaymentAction();
int SetPaymentAction(int iPaymentAction);

Unicode (Windows)
INT GetPaymentAction();
INT SetPaymentAction(INT iPaymentAction);

A_SALE(0), 
A_AUTHORIZATION(1), 
A_ORDER(2)

int inpay_expresscheckout_getpaymentaction(void* lpObj);
int inpay_expresscheckout_setpaymentaction(void* lpObj, int iPaymentAction);

int GetPaymentAction();
int SetPaymentAction(int iPaymentAction);

Default Value

0

Remarks

This property is required when calling the CheckoutPayment method.

This property is required when calling the SetCheckout method.

Possible values of this property include:

Data Type

Integer

ProxyAuthScheme Property (ExpressCheckout 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_expresscheckout_getproxyauthscheme(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getproxyautodetect(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getproxypassword(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getproxyport(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getproxyserver(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getproxyssl(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getproxyuser(void* lpObj);
int inpay_expresscheckout_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

ResponseToken Property (ExpressCheckout Class)

The time-stamped token value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseToken();

Unicode (Windows)
LPWSTR GetResponseToken();

char* inpay_expresscheckout_getresponsetoken(void* lpObj);

QString GetResponseToken();

Default Value

""

Remarks

This property is returned after all three kinds of Express Checkout requests: SetCheckout. GetCheckoutDetails, and CheckoutPayment. This token is used to reference a specific transaction in the PayPal network.

This value is used for several things:

• After calling the SetCheckout method, the value of this property should be appended to the PayPal login page, located here: https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=. The customer's browser should then be redirected to this location. This starts the PayPal payment process.
• After the customer successfully pays, this token is appended as a query string to the value sent in the ReturnURL property. The customer is redirected to this URL (which should reside on your server).
• You must then pass this value in the Token parameter of the GetCheckoutDetails method to continue the transaction.
• The Token property must be set with this value before calling CheckoutPayment.

This token expires after three hours.

This property is read-only.

Data Type

String

ReturnURL Property (ExpressCheckout Class)

URL to which the customer's browser is returned after choosing to pay with PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnURL();
int SetReturnURL(const char* lpszReturnURL);

Unicode (Windows)
LPWSTR GetReturnURL();
INT SetReturnURL(LPCWSTR lpszReturnURL);

char* inpay_expresscheckout_getreturnurl(void* lpObj);
int inpay_expresscheckout_setreturnurl(void* lpObj, const char* lpszReturnURL);

QString GetReturnURL();
int SetReturnURL(QString qsReturnURL);

Default Value

""

Remarks

This is the page to which a customer is returned after he pays through PayPal. The PayPal server will append to this ReturnURL a query string containing a token which identifies this transaction in the PayPal network. This token should be sent as the Token parameter in the GetCheckoutDetails method.

This property is required when calling the SetCheckout method.

Character length and limitations: no limit. Must be URL-encoded.

Data Type

String

ShippingTotal Property (ExpressCheckout 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_expresscheckout_getshippingtotal(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsignature(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslcertstorepassword(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslcertstoretype(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslcertsubject(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getsslprovider(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_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 (ExpressCheckout 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_expresscheckout_gettaxtotal(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_gettimeout(void* lpObj);
int inpay_expresscheckout_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

Token Property (ExpressCheckout Class)

This property is used to reference a specific Express Checkout transaction in the PayPal network.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetToken();
int SetToken(const char* lpszToken);

Unicode (Windows)
LPWSTR GetToken();
INT SetToken(LPCWSTR lpszToken);

char* inpay_expresscheckout_gettoken(void* lpObj);
int inpay_expresscheckout_settoken(void* lpObj, const char* lpszToken);

QString GetToken();
int SetToken(QString qsToken);

Default Value

""

Remarks

PayPal will return a token in the ResponseToken property in response to each request. This value should be saved and passed in the Token property for a CheckoutPayment request, or to modify an existing transaction.

This token expires after three hours.

IMPORTANT: the value of this property can be used to modify an existing checkout session. Normally you call SetCheckout with an empty Token property, and get a ResponseToken back from the PayPal servers. Calling SetCheckout again with the Token property filled will edit that previous checkout session. For instance, this can be used should you want the customer to edit his shipping address on PayPal.

This property is required when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

Character length and limitations: 20 single-byte characters.

Data Type

String

URL Property (ExpressCheckout 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_expresscheckout_geturl(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_getuser(void* lpObj);
int inpay_expresscheckout_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 (ExpressCheckout 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_expresscheckout_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.)

Capture Method (ExpressCheckout 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_expresscheckout_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.)

CheckoutPayment Method (ExpressCheckout Class)

Either obtain payment for a final sale, or request authorization for later capture of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckoutPayment();

Unicode (Windows)
INT CheckoutPayment();

int inpay_expresscheckout_checkoutpayment(void* lpObj);

int CheckoutPayment();

Remarks

This method completes the sale or authorization. When this method is called, the following properties are required in the request:

• Token
• PaymentAction
• OrderTotal
• PayerId (returned after a call to GetCheckoutDetails)

To obtain payment for a final sale you will have to set the PaymentAction property to aSale. If you want to request an authorization, the PaymentAction property has to be set to aAuthorization. Then, you will need to use Capture to capture the transaction.

The following information may be optionally provided in the request:

• OrderDescription
• Custom (Config setting)
• InvoiceNumber
• NotifyURL (Config setting)
• Payment item details (ItemAmount, ItemName, ItemNumber, ItemQuantity, ItemSalesTax)

The Response and Payment properties may be returned in the response.

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 (ExpressCheckout 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_expresscheckout_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 (ExpressCheckout Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

GetCheckoutDetails Method (ExpressCheckout Class)

Returns information about the customer, including name and address on file with PayPal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckoutDetails();

Unicode (Windows)
INT GetCheckoutDetails();

int inpay_expresscheckout_getcheckoutdetails(void* lpObj);

int GetCheckoutDetails();

Remarks

After the customer pays via PayPal and is returned to your ReturnURL, use this method (along with the token returned in the ReturnURL query string) to retrieve payment details about this transaction. After calling this method, all of the fields under the Payer and Payment properties will be populated. Note that PayPal will only return these values if it has this information stored for the paying customer. The PayerId property is required to finalize the sale, but you may want to check other Payer and Payment details to make sure they are correct.

If everything looks good, you may then call CheckoutPayment to complete the transaction.

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 (ExpressCheckout 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_expresscheckout_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 (ExpressCheckout Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int inpay_expresscheckout_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 (ExpressCheckout Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SetCheckout Method (ExpressCheckout Class)

Call this method to begin the Express Checkout process and fetch a token from PayPal which will encode transaction details.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCheckout();

Unicode (Windows)
INT SetCheckout();

int inpay_expresscheckout_setcheckout(void* lpObj);

int SetCheckout();

Remarks

This method queries PayPal for a ResponseToken and begins the Express Checkout process. This token is used to identify the transaction on the PayPal network.

The following properties are required before calling SetCheckout:

• URL
• User
• Password
• Signature
• OrderTotal
• ReturnURL
• CancelURL
• PaymentAction

After calling this method, you should check the Ack property to determine whether the request was successful. If so, append the ResponseToken value to the following PayPal URL, and redirect your customer there.

https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=

The customer will sign in and fill out payment details on PayPal's site. Afterwards PayPal will automatically redirect the customer back to the ReturnURL you specified, along with the updated token appended to the URL. This token should be parsed from the URL and set as the Token property. You may then proceed in calling GetCheckoutDetails and CheckoutPayment.

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 (ExpressCheckout 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_expresscheckout_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 (ExpressCheckout Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_EXPRESSCHECKOUT_ERROR 1

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

class ExpressCheckoutErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass ExpressCheckout and override this emitter function.
virtual int FireError(ExpressCheckoutErrorEventParams *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 (ExpressCheckout Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_EXPRESSCHECKOUT_SSLSERVERAUTHENTICATION 2

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

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

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (ExpressCheckout Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_EXPRESSCHECKOUT_SSLSTATUS 3

virtual INT INPAY_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Config Settings (ExpressCheckout Class)