Pro-Form PFEX19810.0 User's Guide

PayPal Pro Integration GuideItalyLast updated: May 2014

PrefaceDocumentation FeedbackP10

Index100Hhandling 20header 38headerBgColor 40headerHeight 40HOSTED 49HOSTEDBUTTONID 56HTML integration 17HTTP variables 19IiFrames 43API inte

101IndexshowHostedThankyouPage 41showShippingAddress 41simple integration 17state 21subheaderText 41subtotal 21Ttax 21template 42testing your

Index102

111Getting Started with PayPal ProOverviewPayPal Pro is a payment platform allowing merchants to receive payments funded by card or PayPal account.Thi

Getting Started with PayPal ProHow PayPal Pro Works12 Supports Major Credit and Debit Cards - Supports Visa, MasterCard, Carta Aura (processed by Cet

Getting Started with PayPal ProSeller ProtectionSeller ProtectionIf PayPal is the only payment method on your website, transactions processed through

Getting Started with PayPal ProPayPal Express Checkout Transaction Processing14 Verifying the status of a transaction programatically. To check the i

Getting Started with PayPal ProIntroduction to Integrating with PayPal Proplaced on both the product page as well as the shopping cart page and is a g

Getting Started with PayPal ProIntroduction to Integrating with PayPal Pro16

2Integrating Your Website Using HTMLThis chapter provides instructions for a simple integration that enables you to begin processing transactions usin

Integrating Your Website Using HTMLSimple PayPal Pro Integration18The return URL is appended with a Transaction ID on the query string during the redi

19Integrating Your Website Using HTMLHTML Variables for Payment Page SettingsHTML Variables for Payment Page SettingsThe table below lists the PayPal

PayPal Pro Integration GuideDocument Number: 10116.en_US-201308© 1999 - 2014 PayPal, Inc. All rights reserved. PayPal is a registered trademark of Pay

Integrating Your Website Using HTMLHTML Variables for Payment Page Settings20cancel_returnThe browser will be redirected to this URL if the buyer clic

21Integrating Your Website Using HTMLHTML Variables for Payment Page SettingsreturnThe URL to which the buyer’s browser is redirected to after complet

Integrating Your Website Using HTMLHTML Variables for Payment Page Settings22

233Customising Your PayPal Payment PageYou can customise the look and feel of the PayPal payment page in the following two ways: Modifying Your PayPa

Customising Your PayPal Payment PageModifying Your PayPal Account Settings24Modifying Your PayPal Account SettingsThe settings and appearance of your

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsSettingsFIGURE 3.1 Settings - Settings Overview pageFrom the Settings overvi

Customising Your PayPal Payment PageModifying Your PayPal Account Settings26FIGURE 3.2 Settings - Customer Information pageFrom this list of customer

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsInstead of collecting the buyer’s shipping address again on the PayPal payme

Customising Your PayPal Payment PageModifying Your PayPal Account Settings28FIGURE 3.3 Settings - Payment Confirmation Page On my site’s confirmation

Customising Your PayPal Payment PageModifying Your PayPal Account Settings– (Optional) footer text– Customer service phone number. To update your cust

ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7About This Guide. . . . .

Customising Your PayPal Payment PageModifying Your PayPal Account Settings30FIGURE 3.4 Settings - Email ReceiptURLs and Data TransferThe URLs and Data

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsFIGURE 3.5 Settings - URL and Data TransferYou can configure the following s

Customising Your PayPal Payment PageModifying Your PayPal Account Settings32 Cancel URLEnter the URL of the page on your website where the buyer shou

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsCustomisationThe Customisation page allows you to customise the layout and a

Customising Your PayPal Payment PageModifying Your PayPal Account Settings34Layout A. Layout A is selected by default. Layout A consists of a header a

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsLayout B. Layout B has the most customisation options. Like Layout A, it con

Customising Your PayPal Payment PageModifying Your PayPal Account Settings36Layout C. In Layout C, the order summary section appears towards the top o

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsMiniLayout. Unlike the other layouts, MiniLayout shows only the payment meth

Customising Your PayPal Payment PageThe Mobile Optimized Payment Flow38Layout Template Customisation OptionsConsider the following when you customise

Customising Your PayPal Payment PageThe Mobile Optimized Payment Flowinformation, see the template HTML variable in “HTML Variables for Payment Page L

Contents4Chapter 5 Integrating Your Website Using API . . . . . . . . . . . . .49Button Hosting . . . . . . . . . . . . . .

Customising Your PayPal Payment PageHTML Variables for Payment Page Look and Feel40FIGURE 3.12 Mobile Payment Flow for a Credit Card PaymentHTML Varia

Customising Your PayPal Payment PageHTML Variables for Payment Page Look and FeellogoFontColorColor of the logo text.logoFontSizeFont size of the logo

Customising Your PayPal Payment PageHTML Variables for Payment Page Look and Feel42templateThe layout template that will be used for your payment page

4Integrating iFrame in Your WebsitePayPal offers a compact payment form that can be integrated in an iFrame on your website. Since this form is integr

Integrating iFrame in Your WebsiteIntegrating iFrame44 Manually customize the color of the Pay Now button.IMPORTANT:This compact payment form does no

45Integrating iFrame in Your WebsiteIntegrating iFrame2. Below is the iFrame code, add the hidden form that is populated with the appropriate PayPal P

Integrating iFrame in Your WebsiteIntegrating iFrame46<script type="text/javascript"> document.form_iframe.submit();</script>

47Integrating iFrame in Your WebsiteIntegrating iFrameUsing URL Returned in the ResponseIn the URL identified in the response as EMAILLINK, add “src”

Integrating iFrame in Your WebsiteIntegrating iFrame48Example of API (Form POST) IntegrationThe complete example as per the above steps is as follows:

5Integrating Your Website Using APIUsing the Button Manager API, you can programmatically create the checkout button that initiates the PayPal Pro che

5ContentsAppendix A Optional API Operations. . . . . . . . . . . . . . . . . . .73GetTransactionDetails API . . . . . . . .

Integrating Your Website Using APIUsing the Button Manager API with PayPal Pro Checkout50Using the Button Manager API with PayPal Pro CheckoutTo creat

51Integrating Your Website Using APIUsing the Button Manager API with PayPal Pro CheckoutExample of ENCRYPTEDEMAILLINK=https://securepayments.paypal.c

Integrating Your Website Using APIUsing the Button Manager API with PayPal Pro Checkout52Example for TOKENWEBSITECODE=<form action="https://se

53Integrating Your Website Using APIUsing the Button Manager API with PayPal Pro CheckoutNOTE: The PayPal payment page displays a button identified as

Integrating Your Website Using APIUsing the Button Manager API with PayPal Pro Checkout54L_BUTTONVAR23=notify_url=www.yourcompany.comL_BUTTONVAR24=cus

55Integrating Your Website Using APIBMCreateButton API OperationBMCreateButton API OperationUse the BMCreateButton API operation to create PayPal Pro

Integrating Your Website Using APIBMCreateButton API Operation56BMCreateButton ResponseThe response contains an ID if the button is hosted on PayPal,

576Testing Your Integration in SandboxThe PayPal Sandbox is a self-contained environment within which you can prototype and test PayPal features. The

Testing Your Integration in SandboxSandbox Account Credentials58 Upgrade to a Pro account:Click on the arrow next to your Sandbox business account ema

Testing Your Integration in SandboxSandbox Account CredentialsSetup Personal Sandbox Accounts:From the developer site Applications > Sandbox accoun

Contents6

Testing Your Integration in SandboxTesting Your Integration and Settings60Testing Your Integration and SettingsThe following sections contain informat

Testing Your Integration in SandboxTesting Your Integration and SettingsTesting Your SettingsTo change the look and feel of your payment page, modify

Testing Your Integration in SandboxTesting Your Integration and Settings62

637Order ProcessingThis chapter walks you through the end of end order processing experience. It includes information about verifying the status and a

Order ProcessingVerifying Transaction Status and Authenticity64Validate Instant Payment Notification (IPN)IPN enables you to receive messages about tr

65Order ProcessingFulfilling OrderExecute a GetTransactionDetails API CallUsing GetTransactionDetails API, you can obtain information about a specific

Order ProcessingFulfilling Order66

8Protecting Buttons by Using Encrypted Website PaymentsUsing Encrypted Website Payments helps secure payment buttons that you generate or write manual

Protecting Buttons by Using Encrypted Website PaymentsPublic Key Encryption Used by Encrypted Website Payments68Public Key Encryption Used by Encrypte

69Protecting Buttons by Using Encrypted Website PaymentsSetting Up Certificates Before Using Encrypted Website PaymentsGenerating Your Private Key Usi

PPrefaceAbout This GuideThe PayPal Pro Integration Guide describes how to integrate with PayPal Pro. It includes information about: Features and bene

Protecting Buttons by Using Encrypted Website PaymentsSetting Up Certificates Before Using Encrypted Website Payments70Downloading the PayPal Public C

71Protecting Buttons by Using Encrypted Website PaymentsSetting Up Certificates Before Using Encrypted Website PaymentsUsing Encrypted Website Payment

Protecting Buttons by Using Encrypted Website PaymentsSetting Up Certificates Before Using Encrypted Website Payments72where the argument is:– CertFil

A 73Optional API OperationsUsing the Transaction ID, a number of PayPal API operations are available. The most commonly used for PayPal Pro are: Get

Optional API OperationsGetTransactionDetails API74GetTransactionDetails ResponseNOTE: All fields defined in the formal structure of GetTransactionDeta

Optional API OperationsGetTransactionDetails APIPayer Information FieldsPayer Name FieldsTABLE A.3 Payer Information FieldsField DescriptionEMAILEmail

Optional API OperationsGetTransactionDetails API76Address FieldsSUFFIXPayer’s suffix.Character length and limitations - 12single-byte alphanumeric cha

Optional API OperationsGetTransactionDetails APIPayment Information FieldsTABLE A.6 Payment Information FieldsField DescriptionTRANSACTIONIDUnique tra

Optional API OperationsGetTransactionDetails API78FEEAMTPayPal fee amount charged for the transactionCharacter length and limitations - Does not excee

Optional API OperationsGetTransactionDetails APIPAYMENTSTATUSStatus of the payment.The status of the payment: None - No status Canceled-Reversal - A

PrefaceRevision HistoryP8For more information go to https://developer.paypal.com/webapps/developer/docs/classic/products/website-payments-pro-hosted-s

Optional API OperationsGetTransactionDetails API80PENDINGREASONNOTE:PendingReason is returned in the response only if PaymentStatus is Pending.The rea

Optional API OperationsGetTransactionDetails APIPayment Item Information FieldsPROTECTIONELIGIBILITYSince version 64.4, the kind of seller protection

Optional API OperationsGetTransactionDetails API82Payment Item FieldsAuction FieldsTABLE A.8 Payment Item FieldsField DescriptionL_DESCnDescription of

Optional API OperationsRefundTransaction APISubscription Term FieldsRefundTransaction APIIssue a refund to the PayPal account holder associated with a

Optional API OperationsDoCapture API84RefundTransaction Response DoCapture APICapture an authorized payment. DoCapture Request DoCapture ResponseDoC

Optional API OperationsDoCapture APICOMPLETETYPE(Required) The value Complete indicates that this the last capture you intend to make.The value NotCom

Optional API OperationsDoCapture API86SOFTDESCRIPTOR(Optional) The soft descriptor is a per transaction description of the payment that is passed to t

Optional API OperationsDoCapture APIDoCapture Response  DoCapture Response Fields PayerInfo Type Fields Ship To Address Fields Payer Name FieldsNO

Optional API OperationsDoCapture API88Ship To Address FieldsBUSINESSPayer’s business name.Character length and limitations - 127 single-byte character

Optional API OperationsDoCapture APIPayer Name FieldsTABLE A.17 Payer Name FieldsField DescriptionSALUTATIONPayer’s salutation.Character length and li

9PrefaceDocumentation FeedbackPDocumentation FeedbackHelp us improve this guide by sending feedback to:[email protected] 2012 Added

Optional API OperationsDoCapture API90

B 91Moving from Website Payments Standard to PayPal ProIf you are moving from Website Payment Standard to PayPal Pro, you must make the following cha

Moving from Website Payments Standard to PayPal Pro92Sample Code ComparisonBelow is a comparison of Website Payment Standard code and PayPal Pro code.

Moving from Website Payments Standard to PayPal Pro<input type="hidden" name="first_name" value="John"><input t

Moving from Website Payments Standard to PayPal Pro94

C 95Error MessagesRefer to the PayPal API error codes page to lookup an error code number or an error message.

Error Messages96

D Currency CodesThe table below lists all the currencies supported by PayPal. TABLE D.1 Currency CodesCurrency CodeCountry NameAUD Australian DollarC

Currency Codes98

99IndexAaddress_override 19address1 19address2 19API integration 49appearance 33Bbackground 38billing_address1 19billing_address2 19billing_ci