ExpressCheckout Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ExpressCheckout

Remarks

The ExpressCheckout control 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 control'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 control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

Ack Property (ExpressCheckout Control)

Acknowledgement code received from PayPal.

Syntax

expresscheckoutcontrol.Ack

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

Buyer's email address.

Syntax

expresscheckoutcontrol.BuyerEmail[=string]

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

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

Syntax

expresscheckoutcontrol.CancelURL[=string]

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

Payer's contact telephone number.

Syntax

expresscheckoutcontrol.ContactPhone

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

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

Syntax

expresscheckoutcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (ExpressCheckout Control)

This property determines the type of firewall to connect through.

Syntax

expresscheckoutcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

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

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

Syntax

expresscheckoutcontrol.FirewallHost[=string]

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 control fails with an error.

Data Type

String

FirewallPassword Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.FirewallPassword[=string]

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 control fails with an error.

Data Type

String

FirewallPort Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.FirewallPort[=integer]

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

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

Syntax

expresscheckoutcontrol.FirewallUser[=string]

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 control fails with an error.

Data Type

String

Idle Property (ExpressCheckout Control)

The current status of the control.

Syntax

expresscheckoutcontrol.Idle

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

Your own unique invoice or tracking number.

Syntax

expresscheckoutcontrol.InvoiceNumber[=string]

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

The number of records in the Item arrays.

Syntax

expresscheckoutcontrol.ItemCount[=integer]

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

Amount of charged on payment.

Syntax

expresscheckoutcontrol.ItemAmount(ItemIndex)[=string]

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

Paypal item description for the shopping cart.

Syntax

expresscheckoutcontrol.ItemDescription(ItemIndex)[=string]

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

Name of the item purchased.

Syntax

expresscheckoutcontrol.ItemName(ItemIndex)[=string]

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

Item number set by the merchant.

Syntax

expresscheckoutcontrol.ItemNumber(ItemIndex)[=string]

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

Paypal item options for the shopping cart.

Syntax

expresscheckoutcontrol.ItemOptions(ItemIndex)[=string]

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

Quantity of items ordered.

Syntax

expresscheckoutcontrol.ItemQuantity(ItemIndex)[=integer]

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

Amount of tax charged on payment.

Syntax

expresscheckoutcontrol.ItemSalesTax(ItemIndex)[=string]

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

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

Syntax

expresscheckoutcontrol.Note[=string]

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

Description of items the customer is purchasing.

Syntax

expresscheckoutcontrol.OrderDescription[=string]

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

The total cost of the order to the customer.

Syntax

expresscheckoutcontrol.OrderTotal[=string]

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

Password for communicating with PayPal.

Syntax

expresscheckoutcontrol.Password[=string]

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

Payer's business email address.

Syntax

expresscheckoutcontrol.PayerBusiness

Default Value

""

Remarks

Payer's business email address.

This property is read-only.

Data Type

String

PayerCity Property (ExpressCheckout Control)

Payer's city name.

Syntax

expresscheckoutcontrol.PayerCity

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

Payer's country code.

Syntax

expresscheckoutcontrol.PayerCountryCode

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

Email address of the payer.

Syntax

expresscheckoutcontrol.PayerEmail

Default Value

""

Remarks

Email address of the payer.

This property is optional.

This property is read-only.

Data Type

String

PayerFirstName Property (ExpressCheckout Control)

Payer's first name.

Syntax

expresscheckoutcontrol.PayerFirstName

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

Payer's last name.

Syntax

expresscheckoutcontrol.PayerLastName

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

Payer's state or province name.

Syntax

expresscheckoutcontrol.PayerState

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

Indicates whether the payer is verified or not.

Syntax

expresscheckoutcontrol.PayerStatus

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

Payer's street address (first line).

Syntax

expresscheckoutcontrol.PayerStreet1

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

Payer's street address (second line).

Syntax

expresscheckoutcontrol.PayerStreet2

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

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

Syntax

expresscheckoutcontrol.PayerZip

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

Unique encrypted PayPal customer account number.

Syntax

expresscheckoutcontrol.PayerId[=string]

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

This is the time/date stamp of payment.

Syntax

expresscheckoutcontrol.PaymentDate

Default Value

""

Remarks

This is the time/date stamp of payment.

This property is read-only.

Data Type

String

PaymentExchangeRate Property (ExpressCheckout Control)

Exchange rate if a currency conversion occurred.

Syntax

expresscheckoutcontrol.PaymentExchangeRate

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

PayPal fee amount charged for the transaction.

Syntax

expresscheckoutcontrol.PaymentFeeAmount

Default Value

""

Remarks

PayPal fee amount charged for the transaction.

This property is read-only.

Data Type

String

PaymentGrossAmount Property (ExpressCheckout Control)

The final amount charged.

Syntax

expresscheckoutcontrol.PaymentGrossAmount

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

Indicates whether the payment is instant or delayed.

Syntax

expresscheckoutcontrol.PaymentType

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

The reason the payment is pending.

Syntax

expresscheckoutcontrol.PaymentPendingReason

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

Amount deposited in your PayPal account after a currency conversion.

Syntax

expresscheckoutcontrol.PaymentSettleAmount

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

Status of the payment.

Syntax

expresscheckoutcontrol.PaymentStatus

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

Tax charged on the transaction.

Syntax

expresscheckoutcontrol.PaymentTaxAmount

Default Value

""

Remarks

Tax charged on the transaction.

This property is read-only.

Data Type

String

PaymentTransactionId Property (ExpressCheckout Control)

Unique transaction ID of the payment.

Syntax

expresscheckoutcontrol.PaymentTransactionId

Default Value

""

Remarks

Unique transaction ID of the payment.

This property is read-only.

Data Type

String

PaymentTransactionType Property (ExpressCheckout Control)

The type of transaction.

Syntax

expresscheckoutcontrol.PaymentTransactionType

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

How you want to obtain payment.

Syntax

expresscheckoutcontrol.PaymentAction[=integer]

Possible Values

aSale(0), 
aAuthorization(1), 
aOrder(2)

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

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

Syntax

expresscheckoutcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control 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 control. Look at the configuration file for the control 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 Control)

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

Syntax

expresscheckoutcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.ProxyPassword[=string]

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

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

Syntax

expresscheckoutcontrol.ProxyPort[=integer]

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

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

Syntax

expresscheckoutcontrol.ProxyServer[=string]

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

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

Syntax

expresscheckoutcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

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

This property contains a user name, if authentication is to be used for the proxy.

Syntax

expresscheckoutcontrol.ProxyUser[=string]

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

The time-stamped token value.

Syntax

expresscheckoutcontrol.ResponseToken

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

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

Syntax

expresscheckoutcontrol.ReturnURL[=string]

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

Total shipping costs for this order.

Syntax

expresscheckoutcontrol.ShippingTotal[=string]

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

Value to use with PayPal's Signature Authentication scheme.

Syntax

expresscheckoutcontrol.Signature[=string]

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

This is the certificate (PEM/base64 encoded).

Syntax

expresscheckoutcontrol.SSLAcceptServerCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (ExpressCheckout Control)

This is the certificate (PEM/base64 encoded).

Syntax

expresscheckoutcontrol.SSLCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.SSLCertStore[=string]

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.SSLCertStorePassword[=string]

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

This is the type of certificate store for this certificate.

Syntax

expresscheckoutcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.SSLCertSubject[=string]

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

This specifies the SSL/TLS implementation to use.

Syntax

expresscheckoutcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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 control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (ExpressCheckout Control)

This is the certificate (PEM/base64 encoded).

Syntax

expresscheckoutcontrol.SSLServerCertEncoded

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

TaxTotal Property (ExpressCheckout Control)

Sum of tax for all items included in this order.

Syntax

expresscheckoutcontrol.TaxTotal[=string]

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

A timeout for the control.

Syntax

expresscheckoutcontrol.Timeout[=integer]

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

Token Property (ExpressCheckout Control)

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

Syntax

expresscheckoutcontrol.Token[=string]

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

URL all PayPal payment transactions are posted to.

Syntax

expresscheckoutcontrol.URL[=string]

Default Value

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

Remarks

This is the URL to which the control 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 Control)

User name for communicating with Paypal.

Syntax

expresscheckoutcontrol.User[=string]

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

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

Syntax

expresscheckoutcontrol.AddCustomField Name, Value

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 control automatically after each request.

Capture Method (ExpressCheckout Control)

Completely or partially settles a previously authorized transaction.

Syntax

expresscheckoutcontrol.Capture AuthorizationId, Amount

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.

CheckoutPayment Method (ExpressCheckout Control)

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

Syntax

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

Config Method (ExpressCheckout Control)

Sets or retrieves a configuration setting.

Syntax

expresscheckoutcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

DoEvents Method (ExpressCheckout Control)

Processes events from the internal message queue.

Syntax

expresscheckoutcontrol.DoEvents 

Remarks

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

GetCheckoutDetails Method (ExpressCheckout Control)

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

Syntax

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

GetResponseVar Method (ExpressCheckout Control)

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

expresscheckoutcontrol.GetResponseVar Name

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

Interrupt Method (ExpressCheckout Control)

Interrupt the current method.

Syntax

expresscheckoutcontrol.Interrupt 

Remarks

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

Reset Method (ExpressCheckout Control)

Clears all properties to their default values.

Syntax

expresscheckoutcontrol.Reset 

Remarks

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

SetCheckout Method (ExpressCheckout Control)

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

Syntax

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

VoidTransaction Method (ExpressCheckout Control)

Voids a prior authorization.

Syntax

expresscheckoutcontrol.VoidTransaction AuthorizationId

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 Event (ExpressCheckout Control)

Information about errors during data delivery.

Syntax

Sub expresscheckoutcontrol_Error(ErrorCode As Integer, Description As String)

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

Fired after the server presents its certificate to the client.

Syntax

Sub expresscheckoutcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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

Shows the progress of the secure connection.

Syntax

Sub expresscheckoutcontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (ExpressCheckout Control)

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Trappable Errors (ExpressCheckout Control)

ExpressCheckout Errors

	22202    Server error response.
	22203    You attempted to set a property with invalid data.
	22204    You must set additional properties before attempting this function.

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

	20119    Firewall Error. Error description contains detailed message.
	20144    Busy executing current method.
	20152    HTTP protocol error. The error message has the server response.
	20153    No server specified in URL
	20154    Specified URLScheme is invalid.
	20156    Range operation is not supported by server.
	20157    Invalid cookie index (out of range).
	20302    Interrupted.
	20303    Can't open AttachedFile.

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

	20101    You cannot change the RemotePort at this time. A connection is in progress.
	20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103    The RemoteHost address is invalid (0.0.0.0).
	20105    Already connected. If you want to reconnect, close the current connection first.
	20107    You cannot change the LocalPort at this time. A connection is in progress.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20113    You cannot change MaxLineLength at this time. A connection is in progress.
	20117    RemotePort cannot be zero. Please specify a valid service port number.
	20118    You cannot change the UseConnection option while the control is active.
	20136    Operation would block.
	20202    Timeout.
	20212    Action impossible in control's present state.
	20213    Action impossible while not connected.
	20214    Action impossible while listening.
	20302    Timeout.
	20303    Could not open file.
	20435    Unable to convert string to selected CodePage.
	21106    Already connecting. If you want to reconnect, close the current connection first.
	21118    You need to connect first.
	21120    You cannot change the LocalHost at this time. A connection is in progress.
	21121    Connection dropped by remote host.

SSL Errors

	20271    Cannot load specified security library.
	20272    Cannot open certificate store.
	20273    Cannot find specified certificate.
	20274    Cannot acquire security credentials.
	20275    Cannot find certificate chain.
	20276    Cannot verify certificate chain.
	20277    Error during handshake.
	20281    Error verifying certificate.
	20282    Could not find client certificate.
	20283    Could not find server certificate.
	20284    Error encrypting data.
	20285    Error decrypting data.

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).