PayPal Website Payments Pro - 2012 - Hosted Solution Guia do Utilizador

Website Payments Pro Hosted Solution Integration GuideLast updated: July 2012

Getting Started with Website Payments Pro Hosted SolutionHow Hosted Solution Works10 Support for 3-D Secure Buyer Authentication Protocol - 3-D Secur

Getting Started with Website Payments Pro Hosted SolutionValue-Added Services1. Generate a button in your website checkout flow using HTML or API solu

Getting Started with Website Payments Pro Hosted SolutionPayPal Express Checkout Transaction Processing12Recurring PaymentsRecurring Payments is a sch

Getting Started with Website Payments Pro Hosted SolutionIntroduction to Integrating with Hosted SolutionFor complete details on PayPal Express Checko

Getting Started with Website Payments Pro Hosted SolutionIntroduction to Integrating with Hosted Solution14

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 Hosted Solution Integration16The return URL is appended with a Transaction ID on the query string during the

17Integrating Your Website Using HTMLHTML VariablesHTML VariablesThe table below lists the Hosted Solution HTML variables you can use to send in addit

Integrating Your Website Using HTMLHTML Variables18cancel_returnThe browser will be redirected to this URL if the buyer clicks “Return to Merchant” li

19Integrating Your Website Using HTMLHTML VariablesreturnThe URL to which the buyer’s browser is redirected to after completing the payment. Be sure t

Website Payments Pro Hosted Solution Integration GuideDocument Number: 10112.en_GB-201207© 2012 PayPal, Inc. All rights reserved. PayPal is a register

Integrating Your Website Using HTMLHTML Variables20

213Customising 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 Settings22

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsSettingsThis page allows you to select the information you want to collect a

Customising Your PayPal Payment PageModifying Your PayPal Account Settings24What information do you want to show on your Website Payments Pro Hosted S

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsCustomisationThis page allows you to customise your payment page. You can cu

Customising Your PayPal Payment PageModifying Your PayPal Account Settings26N OTE: Your buyers will not see the payment page until you have completed

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsChoosing a TemplateChoose from the following three design templates: Templa

Customising Your PayPal Payment PageModifying Your PayPal Account Settings28Template B. Customise the header, background, title, button, and the order

Customising Your PayPal Payment PageModifying Your PayPal Account SettingsTemplate C. Customise the header, background, title, and the button.FIGURE 3

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

Customising Your PayPal Payment PageModifying Your PayPal Account Settings30Customising Your TemplateConsider the following when you customise your te

Customising Your PayPal Payment PageAdding HTML VariablesAdding HTML VariablesThe table below lists the Hosted Solution HTML variables you can use to

Customising Your PayPal Payment PageAdding HTML Variables32showCustomerNameDisplay customer name (first name and last name). Default Value: true All

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 iFrame34Integrating iFrameChoose one of the following methods to integrate the compact payment form in y

35Integrating iFrame in Your WebsiteIntegrating iFrame3. Ensure that the target name matches the iFrame name, as highlighted in the example below:<

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

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

Integrating iFrame in Your WebsiteIntegrating iFrame38

5Integrating Your Website Using APIUsing the Button Manager API, you can programmatically create the checkout button that initiates the Hosted Solutio

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

Integrating Your Website Using APIUsing the Button Manager API with Hosted Solution Checkout40Using the Button Manager API with Hosted Solution Checko

41Integrating Your Website Using APIUsing the Button Manager API with Hosted Solution CheckoutExample of ENCRYPTEDEMAILLINK=https://www.paypal.com/acq

Integrating Your Website Using APIUsing the Button Manager API with Hosted Solution Checkout42Example for TOKENWEBSITECODE=<form action="https

43Integrating Your Website Using APIUsing the Button Manager API with Hosted Solution CheckoutN OTE: The PayPal payment page displays a button identif

Integrating Your Website Using APIUsing the Button Manager API with Hosted Solution Checkout44L_BUTTONVAR23=notify_url=www.yourcompany.comL_BUTTONVAR2

45Integrating Your Website Using APIBMCreateButton API OperationBMCreateButton API OperationUse the BMCreateButton API operation to create Hosted Solu

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

47Integrating Your Website Using APIBMCreateButton API Operation11934 Invalid Data You must specify the same number of entries for option prices and s

Integrating Your Website Using APIBMCreateButton API Operation48

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

5ContentsGetTransactionDetails API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63GetTransact

Testing Your Integration in SandboxCreating a Preconfigured Account50To test your Hosted Solution integration, create a preconfigured account using th

Testing Your Integration in SandboxCreating a Preconfigured Account3. Choose United Kingdom from the Country drop-down menu.4. Select Website Payments

Testing Your Integration in SandboxCreating a Preconfigured Account528. Click Enter Sandbox Test Site. The Sandbox Test Site appears in a different br

Testing Your Integration in SandboxTesting Your Integration and SettingsTesting Your Integration and SettingsThe following sections contain informatio

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

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

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

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 Payments58Public Key Encryption Used by Encrypte

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

Contents6

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

61Protecting 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 Payments62where the argument is:– CertFil

A 63Optional API OperationsUsing the Transaction ID, a number of PayPal API operations are available. The most commonly used for Hosted Solution are:

Optional API OperationsGetTransactionDetails API64GetTransactionDetails ResponseN OTE: All fields defined in the formal structure of GetTransactionDet

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

Optional API OperationsGetTransactionDetails API66Address 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 API68FEEAMTPayPal 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

PPrefaceAbout This GuideThe Website Payments Pro Hosted Solution Integration Guide describes how to integrate with Hosted Solution. It includes inform

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

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

Optional API OperationsGetTransactionDetails API72Payment Item FieldsAuction FieldsTABLE A.8 Payment Item FieldsField DescriptionL_DESCnAmount of tax

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

Optional API OperationsDoCapture API74RefundTransaction 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 API76SOFTDESCRIPTOR(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 FieldsN

Optional API OperationsDoCapture API78Ship 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

PrefaceDocumentation FeedbackP8Documentation FeedbackHelp us improve this guide by sending feedback to:[email protected]

Optional API OperationsDoCapture API80

B 81Moving from Website Payments Standard to Hosted SolutionIf you are moving from Website Payment Standard to Hosted Solution, you must make the fol

Moving from Website Payments Standard to Hosted Solution82Sample Code ComparisonBelow is a comparison of Website Payment Standard code and Hosted Solu

Moving from Website Payments Standard to Hosted Solution<input type="hidden" name="city" value="San Jose"><inpu

Moving from Website Payments Standard to Hosted Solution84

C 85Error MessagesThe table below lists error codes and the appropriate correction action.TABLE C.1 Error Codes and the Corresponding Corrective Acti

Error Messages8610505 Your payment can't be processed. Please contact the merchant directly with this code.Transaction was refused because the AV

87Error Messages10536 Your payment can't be processed. Please contact the merchant directly with this code.All shopping cart items must be in the

Error Messages8810548 Your payment can't be processed. Please contact the merchant directly with this code.Merchant account attempting the transa

89Error Messages10560 Please enter a valid card issue number.Buyer should enter a valid card number.10561 Please enter a complete billing address.Buye

91Getting Started with Website Payments Pro Hosted SolutionOverviewWebsite Payments Pro provides an all-in-one package of a gateway, a merchant accoun

Error Messages9010706 Please enter a valid ZIP code in the billing address.Buyer should enter a valid zip code in the billing address.10707 Please ent

91Error Messages10723 Please enter a valid state in the shipping address.Buyer should enter a valid state in the shipping address.10724 Please enter a

Error Messages9210746 Your payment can't be processed. Please contact the merchant directly with this code.Credit card from this country is not s

93Error Messages10763 Your payment can't be processed. Please contact the merchant directly with this code.None - this is a PayPal internal error

Error Messages9415007 Your card is expired. Please pay with a valid card.Transaction was declined by the issuing bank because of an expired credit car

D Currency CodesThe table below lists all the currencies supported by PayPal. TABLE D.1 Currency CodesCurrency Code Country NameAUD Australian Dollar

Currency Codes96

97IndexNumerics3-D Secure 10, 24Aaddress_override 17address1 17address2 17API integration 39Bbackground 30billing_address1 17billing_address2 17billin

Index98GGetTransactionDetails API 56, 63Hhandling 18header 30headerBgColor 31headerHeight 31HOSTED 39HOSTEDBUTTONID 46HTML integration 15HTTP variable

99Indexshipping 19showBillingAddress 32showBillingEmail 32showBillingPhone 32showCustomerName 32showHostedThankyouPage 32showShippingAddress 32simple