ExpressCheckout Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

nsoftware.InPayPal.Expresscheckout

Remarks

The ExpressCheckout component 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 component'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 use the ReAuthCapture component to capture the transaction.