/n software PayPal expresscheckout Component : expresscheckout OCX, expresscheckout .NET Component, expresscheckout Class, expresscheckout Bean, expresscheckout Object

Available in: PAYPAL

ExpressCheckout Component [IBiz PayPal Integrator V2]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The ExpressCheckout component is used when a customer purchases an item from a merchant's website, and decides to use PayPal to pay for it. There are three different methods, SetCheckout, CheckoutPayment, and GetCheckoutDetails, which are used together to complete a transaction.

At the time of this writing, in order to use this component you must have a PayPal Business account to accept direct payments, and you must apply to have "Website Payments Pro" activated on your account. Once that is accomplished and you have set up API access, accepting credit cards is simple.

The first thing a merchant does when a customer decides to pay by PayPal, is to send the customer's email address to PayPal, and receive a transaction token (returned in the ResponseToken property).

After receiving the token, you must redirect the customer to PayPal's express checkout URL, along with the ResponseToken you just received. After the customer pays, he will be returned to the ReturnURL you specified in the request. For example:

component.OrderTotal = "88.88" component.ReturnURL = "http://localhost" component.CancelURL = "http://localhost" component.PaymentAction = aSale component.BuyerEmail = "IBizTester@nsoftware.com" component.SetCheckout() 'Now redirect the buyer: If (component.Ack == "success") Then Redirect("https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=" + component.ResponseToken) End If

After the buyer is returned to your ReturnURL, you must acquire the PayerId by calling the GetCheckoutDetails method with the token returned above. Additional data about the buyer will also be returned, such as name, address, status within the PayPal system, and phone number. For example:

component.GetCheckoutDetails("EC-9EN563578B985082M") ' token value from above

PayerId now contains the value required to complete the transaction, using the CheckoutPayment method. For example:

component.PaymentAction = aSale component.Token = "EC-9EN563578B985082M" ' token value from above component.OrderTotal = "88.88" component.CheckoutPayment()

If you submitted a PaymentAction of aSale, this will finalize the transaction and transfer funds to your PayPal account. However, if the PaymentAction is set to aAuthorization you will need to use the REAUTHCAPTURE component to capture the transaction.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Ack	Acknowledgement code received from PayPal.
BuyerEmail	Buyer's email address.
CancelURL	URL to which the customer is returned if he decides not to pay with PayPal.
ContactPhone	Payer's contact telephone number.
CurrencyCode	Type of currency in which you are accepting payments.
InvoiceNumber	Your own unique invoice or tracking number.
ItemAmount	Cost of an individual item included in the order.
ItemCount	Number of items included in the order.
ItemName	Name of an individual item included in the order.
ItemNumber	The number that uniquely identifies an individual item included in the order.
ItemQuantity	Quantity of an individual item included in the order.
ItemSalesTax	Sales tax applied to an individual item included in the order.
OrderDescription	Description of items the customer is purchasing.
OrderTotal	The total cost of the order to the customer.
Password	Password for communicating with PayPal.
PayerBusiness	Payer's business email address.
PayerCity	Payer's city name.
PayerCountryCode	Payer's country code.
PayerEmail	Payer's email address.
PayerFirstName	Payer's first name.
PayerId	Unique encrypted PayPal customer account number.
PayerLastName	Payer's last name.
PayerPostalCode	Payer's U.S. Zip code or other country-specific postal code.
PayerState	Payer's state or province.
PayerStatus	Status of payer with PayPal (verified or unverified).
PayerStreet1	Payer's street address (first line).
PayerStreet2	Payer's street address (second line).
PaymentAction	How you want to obtain payment.
PaymentDate	Time/date stamp of payment.
PaymentExchangeRate	Exchange rate if a currency conversion occurred.
PaymentFeeAmount	PayPal fee amount charged for the transaction.
PaymentGrossAmount	The final amount charged.
PaymentPendingReason	The reason the payment is pending.
PaymentSettleAmount	Amount deposited in your PayPal account after a currency conversion.
PaymentStatus	Status of the payment.
PaymentTaxAmount	Tax charged on the transaction.
PaymentTransactionId	Unique transaction ID of the payment.
PaymentTransactionType	The type of transaction.
PaymentType	Indicates whether the payment is instant or delayed.
ResponseToken	The time-stamped token value.
ReturnURL	URL to which the customer's browser is returned after choosing to pay with PayPal.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
ShippingTotal	Total shipping costs for this order.
Signature	Value to use with PayPal's Signature Authentication scheme.
TaxTotal	Sum of tax for all items included in this order.
Timeout	A timeout for the component.
Token	This property is used to reference a specific Express Checkout transaction in the PayPal network.
URL	URL all PayPal transactions are posted to.
User	User name for communicating with Paypal.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


CheckoutPayment	Either obtain payment for a final sale, or request authorization for later capture of payment.
Config	Sets or retrieves a component configuration setting.
GetCheckoutDetails	Returns information about the customer, including name and address on file with PayPal.
Reset	Reset the internal state of the component and all properties to their default values.
SetCheckout	Indicates to PayPal that you are using Express Checkout to obtain payment from your customer.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AuthorizingAccount	Authorizing Account Email Address for third-party API access.
Build	Returns the Build number contained in the response.
ButtonSource	Additional information for identifying transactions.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
CurrencyCode	Type of currency in which you are accepting payments.
Custom	A free-form field for your own use.
FaultCode	Returns the SOAP fault code, if any.
FaultString	Returns the error message associated with the SOAP fault code.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion	The version of HTTP used by the component
HandlingTotal	Total handling costs for this order.
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
ItemTotal	Sum of cost of all items in this order.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
LocaleCode	Locale of pages displayed by PayPal during Express Checkout
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
NotifyURL	Instant Payment Notification (IPN) URL.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if Basic authentication is to be used for the proxy.
ResponseVersion	Returns the Version number contained in the response.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification
ShipToPayerAddress	Shipping address same as billing address.
ShippingAddress	Payer's shipping address.
SocketHandle	The handle of the main socket used by the component.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
Version	Allows the user to set the Version number in the request.
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)