Website Payments Pro integration guide

Merchants and developers can use Website Payments Pro to accept credit cards, debit cards, and PayPal payments directly on their website. Website Payments Pro also includes PayPal's Express Checkout and Virtual Terminal.

Important: Website Payments Pro has been replaced by PayPal Payments Pro. Website Payments Pro is still supported for existing merchants. See the PayPal Payments Pro / Payflow documentation for Payflow integration information.

Overview

To accept payments on your website with Website Payments Pro, you can integrate with the Direct Payment and Express Checkout API solutions.

  • Direct Payment enables you to accept both debit and credit cards directly from your site.

  • Express Checkout enables you to accept payments from PayPal accounts in addition to debit and credit cards.

These payments can be immediate or authorized for later capture; they can also be recurring payments and reference transactions.

Website Payments Pro also includes standalone applications for accepting payments, such as Virtual Terminal and Fraud Management Filters, for automatic review and management of risk.

The following diagram shows the relationship between Direct Payment and Express Checkout to a buyer.

  1. From your shopping cart, a buyer can use Express Checkout to check out, starting from the Checkout with PayPal button on your Shopping Cart page, or Direct Payment to pay directly by credit or debit card.

  2. If a buyer pays using Express Checkout, PayPal provides a checkout experience that streamlines checkout. Even if buyers do not pay using Express Checkout, they can still pay by credit or debit card using Direct Payment. In this case, buyers might need to enter payment, billing, and shipping information. In both cases, buyers can stay on your website or are sent to the page of your choice.

  3. You must implement both an Express Checkout flow and a Direct Payment flow to use Website Payments Pro. You implement the Express Checkout flow by calling PayPal's Express Checkout API operations, which guides a buyer through the checkout process. You implement the Direct Payment flow using your own code, for which PayPal provides an API operation to process the credit or debit card payment.

Note: Purchases through Direct Payment are not covered by the PayPal Seller Protection Policy.

Features

Direct Payment The Direct Payment API lets buyers who do not have a PayPal account use their credit cards without leaving your website. PayPal processes the payment in the background.
Authorization & Capture A payment authorization request represents an agreement to pay and places the buyer's funds on hold for an honor period until you capture the funds.
Card Verifications A card verification is used to verify that a cardholder's account is in good standing without processing a purchase transaction or applying a card authorization.
Recurring Payments A recurring payment handles subscriptions, billing agreements or other payments that occur on a fixed schedule.
Reference Transactions A reference transaction is a financial transaction from which subsequent transactions can be derived. For example, a buyer purchases an item on your site, and you use the PayPal transaction ID or reference transaction ID later to initiate another transaction, which you and the buyer have agreed on.
Express Checkout Website Payments Pro merchants can use Express Checkout, PayPal's premier checkout solution.
Security Features Merchants can sign-up for Fraud Management Filters, which can identify potentially fraudulent transactions. Also, UK merchants can take advantage of 3-D Secure to authenticate buyers via Verified by Visa and MasterCard SecureCode.
Virtual Terminal PayPal's Virtual Terminal is a web-based application that allows you to accept credit card payments. It is available to merchants in the United States, Canada, France, and the United Kingdom. Virtual Terminal provides your business with the functionality similar to a stand-alone credit card-processing terminal. Virtual Terminal is ideal when you receive orders by phone, fax, or by mail and want to accept credit cards. An optional card reader is available to process face-to-face purchases; however, some restrictions apply. You can use Virtual Terminal on any computer with an internet connection and a web browser.
Hosted Solution Hosted Solution, which is available to merchants in the United Kingdom as part of Website Payments Pro, is a fast and easy way to add transaction processing to your website. It is a secure, PayPal-hosted, web-based payment solution that allows you to securely send your buyers to PayPal's payment page to authorize and process transactions. Buyers pay with a debit or credit card, or their PayPal account. You do not have to capture or store credit card information on your website, thereby helping towards achieving PCI compliance. Hosted Solution is the choice for merchants who prefer a solution where all financial details are handled by PayPal.
Event Notification In most cases you can use the GetTransactionDetails API operation to determine the information you need about a transaction. However, there may be some cases in which you must set up Instant Payment Notifications (IPN); for example, when you need automatic notification about actions, such as disputes and their resolution. IPN is a message service that PayPal uses to notify you about events, such as, payment transaction status changes, chargebacks, recurring payment / subscription actions, eCheck payments and more.

API operations

To get started with the PayPal name-value pair (NVP) or SOAP APIs, see the NVP/SOAP API Getting Started Guide. Then, learn more about each API message format (NVP or SOAP):

The PayPal API supports a range of payment-related functions related functions. Though most API operations support both Direct Payment and Express Checkout, some are specific to Direct Payment and others are specific to Express Checkout. These API operations are available for both NVP and SOAP integrations.

Operation Description
Direct Payment core API operations: (Direct Payment only)
DoDirectPayment Process a credit card payment, such as a sale or authorization.
DoNonReferencedCredit Issue a credit to a card not referenced by the original transaction.
Note: Contact PayPal to use this API operation; in most cases, you should use the RefundTransaction API operation instead.
Express Checkout core API operations: (Express Checkout only)
SetExpressCheckout Initiates an Express Checkout transaction.
GetExpressCheckoutDetails Obtain information about an Express Checkout transaction.
DoExpressCheckoutPayment Completes an Express Checkout transaction.
Common API operations:
GetTransactionDetails Obtain information about a specific transaction.
ManagePendingTransactionStatus Accept or deny a pending transaction held by Fraud Management Filters.
RefundTransaction Issue a refund to the PayPal account holder associated with a transaction.
TransactionSearch Search transaction history for transactions that meet the specified criteria.
Authorization and Capture API operations:
DoCapture Capture an authorized payment.
DoAuthorization Authorize a payment. (Express Checkout only)
DoReauthorization Reauthorize a previously authorized payment.
DoVoid Void an order or an authorization.
Recurring Payment API operations:
CreateRecurringPaymentsProfile Create a recurring payments profile.
GetRecurringPaymentsProfileDetails Obtain information about a recurring payments profile.
ManageRecurringPaymentsProfileStatus Cancel, suspend, or reactivate a recurring payments profile.
BillOutstandingAmount Bill the buyer for the outstanding balance associated with a recurring payments profile.
UpdateRecurringPaymentsProfile Update a recurring payments profile.
DoReferenceTransaction Process a payment from a buyer's account, which is identified by a previous transaction.
Recurring Payment Billing Agreement API operations: (Express Checkout only)
BAUpdate Update or delete a billing agreement.
GetBillingAgreementCustomerDetails Obtain information about a billing agreement's PayPal account holder.
SetCustomerBillingAgreement Initiates the creation of a billing agreement.
Other Express Checkout API operations: (Express Checkout only)
AddressVerify Confirms whether a postal address and postal code match those of the specified PayPal account holder. (Express Checkout only)
Callback Define the shipping and handling parameters associated with Express Checkout.
GetBalance Obtain the available balance for a PayPal account. (Express Checkout only)
GetPalDetails Obtain your Pal ID, which is the PayPal-assigned merchant account number, and other information about your account.
MassPay Make a payment to one or more PayPal account holders.

Regional differences

Website Payments Pro is available in the United States, Canada, and the United Kingdom. Minor regional differences include the kinds of credit cards accepted and address information. For the most part, this solution works exactly the same in each of these countries. This means that to integrate Website Payments Pro, UK and Canadian merchants can use the same information as US merchants. There are a few minor differences, however, that Canadian and UK merchants should note before they start to integrate.

The following sections identify regional differences:

Credit card support

PayPal accepts buyer credit cards issued in any country. For information on the major credit cards accepted in your country, see major credit cards accepted.

Note: For Direct Payment only, American Express restricts direct card acceptance merchants in certain business categories. Merchants are required to accept the American Express Card Acceptance agreement in order to process American Express cards directly.

Currency support

Direct Payment, like other PayPal products, offers multi-currency functionality. See supported major credit cards and currencies for details.

Addresses

  • For Canada, specify the province code in the State field.
  • For Great Britain, the State field is ignored; however, you still may need to specify a value in the State field; for example, you can specify the city for both the city and state.