PayPal Express Checkout - 2010 User's Guide

Express Checkout Integration GuideLast updated: May 2010

Revision History10 May 2010 Express Checkout Integration Guide06/04/2009 Added a chapter on pre-populating the PayPal review page. Updated PayPal Revi

Implementing Parallel PaymentsIntegrating Parallel Payments Using the NVP API9100 May 2010 Express Checkout Integration GuideThe following syntax repr

Express Checkout Integration Guide May 2010 101Implementing Parallel PaymentsIntegrating Parallel Payments Using the NVP API9– The merchant’s Payer Id

Implementing Parallel PaymentsIntegrating Parallel Payments Using the NVP API9102 May 2010 Express Checkout Integration GuideRequest Parameters:[requi

Express Checkout Integration Guide May 2010 103Implementing Parallel PaymentsIntegrating Parallel Payments Using the SOAP API9Response Parameters[succ

Implementing Parallel PaymentsIntegrating Parallel Payments Using the SOAP API9104 May 2010 Express Checkout Integration GuideIf errors are returned,

Express Checkout Integration Guide May 2010 105Implementing Parallel PaymentsIntegrating Parallel Payments Using the SOAP API9PaymentDetailsType[] Pay

Implementing Parallel PaymentsIntegrating Parallel Payments Using the SOAP API9106 May 2010 Express Checkout Integration Guide } if (Key.Amount

Express Checkout Integration Guide May 2010 107Implementing Parallel PaymentsIntegrating Parallel Payments Using the SOAP API9payment2_item2.Name = &q

Implementing Parallel PaymentsHandling Errors9108 May 2010 Express Checkout Integration GuideHandling ErrorsIt is possible for some merchant payments

Express Checkout Integration Guide May 2010 10910Handling Payment SettlementsYou can use PayPal API operations to handle the capture of payments autho

Express Checkout Integration Guide May 2010 111Introducing Express CheckoutExpress Checkout is PayPal’s premier checkout solution, which streamlines t

Handling Payment SettlementsOrder Payment Action for Express Checkout10110 May 2010 Express Checkout Integration GuideAn authorization enables you to

Express Checkout Integration Guide May 2010 111Handling Payment SettlementsOrder Payment Action for Express Checkout10z Drop shipments, which are ship

Handling Payment SettlementsOrder Payment Action for Express Checkout10112 May 2010 Express Checkout Integration Guide

Express Checkout Integration Guide May 2010 11311Handling Recurring PaymentsSet up a recurring payment to handle subscription and other payments that

Handling Recurring PaymentsRecurring Payments Terms11114 May 2010 Express Checkout Integration Guidez Update the details of the recurring payments pro

Express Checkout Integration Guide May 2010 115Handling Recurring PaymentsOptions for Creating a Recurring Payments Profile11Options for Creating a Re

Handling Recurring PaymentsOptions for Creating a Recurring Payments Profile11116 May 2010 Express Checkout Integration GuideYou can optionally includ

Express Checkout Integration Guide May 2010 117Handling Recurring PaymentsRecurring Payments With Express Checkout11If this field is not set or is set

Handling Recurring PaymentsRecurring Payments With Express Checkout11118 May 2010 Express Checkout Integration GuideThe circled numbers in the diagram

Express Checkout Integration Guide May 2010 119Handling Recurring PaymentsRecurring Payments With Express Checkout11Recurring payments processing flow

Introducing Express CheckoutExpress Checkout Integration Steps112 May 2010 Express Checkout Integration GuideThe following diagram shows the Express C

Handling Recurring PaymentsRecurring Payments With Express Checkout11120 May 2010 Express Checkout Integration Guidez Initiating the processing flow t

Express Checkout Integration Guide May 2010 121Handling Recurring PaymentsRecurring Payments With Express Checkout11https://www.paypal.com/cgi-bin/web

Handling Recurring PaymentsRecurring Payments Profile Status11122 May 2010 Express Checkout Integration GuideRecurring Payments Profile StatusThe recu

Express Checkout Integration Guide May 2010 123Handling Recurring PaymentsModifying a Recurring Payments Profile11z Total number of failed billing cyc

Handling Recurring PaymentsBilling the Outstanding Amount of a Profile11124 May 2010 Express Checkout Integration GuideUpdating AddressesWhen you upda

Express Checkout Integration Guide May 2010 125Handling Recurring PaymentsRecurring Payments Notifications11Recurring Payments NotificationsYou are no

Handling Recurring PaymentsRecurring Payments Notifications11126 May 2010 Express Checkout Integration Guide

Express Checkout Integration Guide May 2010 12712Using Other PayPal API OperationsYou can use additional PayPal API operations to implement additional

Using Other PayPal API OperationsHandling Payment Review12128 May 2010 Express Checkout Integration GuideREFUNDTYPE=Partial 3. For a partial refund, s

Express Checkout Integration Guide May 2010 129Using Other PayPal API OperationsHandling Payment Review12NOTE: You must use version 58.0 to obtain the

Express Checkout Integration Guide May 2010 13Introducing Express CheckoutExpress Checkout Integration Steps1Configuring and Customizing the Express C

Using Other PayPal API OperationsHandling Payment Review12130 May 2010 Express Checkout Integration GuideIMPORTANT: For best results, call the GetTran

Express Checkout Integration Guide May 2010 13113Integrating giropay with Express CheckoutYou must modify your Express Checkout implementation to use

Integrating giropay with Express Checkoutgiropay Page Flows13132 May 2010 Express Checkout Integration GuidePage flow for a successful giropay payment

Express Checkout Integration Guide May 2010 133Integrating giropay with Express Checkoutgiropay Integration13giropay IntegrationIf you offer the girop

Integrating giropay with Express Checkoutgiropay Integration13134 May 2010 Express Checkout Integration GuideComplete the TransactionCorresponding to

Introducing Express CheckoutExpress Checkout Flow114 May 2010 Express Checkout Integration GuideExpress Checkout FlowTo implement Express Checkout, yo

Express Checkout Integration Guide May 2010 15Introducing Express CheckoutExpress Checkout Building Blocks1Integrating Express Checkout from the Shopp

Introducing Express CheckoutExpress Checkout Building Blocks116 May 2010 Express Checkout Integration GuideThe following conceptual diagram identifies

Express Checkout Integration Guide May 2010 17Introducing Express CheckoutExpress Checkout Building Blocks1Express Checkout API OperationsThe PayPal A

Introducing Express CheckoutExpress Checkout Building Blocks118 May 2010 Express Checkout Integration Guidez The token that was included in the redire

Express Checkout Integration Guide May 2010 192Express Checkout Button and Logo Image IntegrationPayPal hosts the PayPal button and logo images that y

Express Checkout Integration GuideDocument Number: 100010.en_US-201005© 2010 PayPal, Inc. All rights reserved. PayPal is a registered trademark of Pay

Express Checkout Button and Logo Image IntegrationDynamic Images220 May 2010 Express Checkout Integration Guidez Static imageThe dynamic images enable

Express Checkout Integration Guide May 2010 21Express Checkout Button and Logo Image IntegrationConfiguring the Dynamic Image2Set Up the Default Image

Express Checkout Button and Logo Image IntegrationDynamic Image Command Reference222 May 2010 Express Checkout Integration GuideChange the LocaleTo sp

Express Checkout Integration Guide May 2010 23Express Checkout Button and Logo Image IntegrationDynamic Image Command Reference2Dynamic Image Paramete

Express Checkout Button and Logo Image IntegrationDynamic Image Command Reference224 May 2010 Express Checkout Integration GuideCountry codes, languag

Express Checkout Integration Guide May 2010 25Express Checkout Button and Logo Image IntegrationStatic PayPal Button and Mark Images Source Requiremen

Express Checkout Button and Logo Image IntegrationStatic PayPal Button and Mark Images Source Requirements226 May 2010 Express Checkout Integration Gu

Express Checkout Integration Guide May 2010 273PayPal Name-Value Pair API BasicsThe Name-Value Pair (NVP) API provides parameter-based association bet

PayPal Name-Value Pair API BasicsPayPal API Client-Server Architecture328 May 2010 Express Checkout Integration GuidePayPal Name-Value Pair API Reques

Express Checkout Integration Guide May 2010 29PayPal Name-Value Pair API BasicsPayPal API Client-Server Architecture3Token UsageTypically, the API ope

Express Checkout Integration Guide May 2010 3ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PayPal Name-Value Pair API BasicsObtaining API Credentials330 May 2010 Express Checkout Integration GuideObtaining API CredentialsTo use the PayPal AP

Express Checkout Integration Guide May 2010 31PayPal Name-Value Pair API BasicsCreating an NVP Request35. Click Done to complete the process.Creating

PayPal Name-Value Pair API BasicsCreating an NVP Request332 May 2010 Express Checkout Integration GuideSpecifying the PayPal API OperationFor the NVP

Express Checkout Integration Guide May 2010 33PayPal Name-Value Pair API BasicsCreating an NVP Request3To enable PayPal to authenticate your request1.

PayPal Name-Value Pair API BasicsExecuting NVP API Operations334 May 2010 Express Checkout Integration GuideList Syntax for Name-Value PairsThe PayPal

Express Checkout Integration Guide May 2010 35PayPal Name-Value Pair API BasicsResponding to an NVP Response3All responses to PayPal API operations co

PayPal Name-Value Pair API BasicsResponding to an NVP Response336 May 2010 Express Checkout Integration GuideURL DecodingAll responses to HTTP POST op

Express Checkout Integration Guide May 2010 374Implementing the Simplest Express Checkout IntegrationThe simplest Express Checkout integration require

Implementing the Simplest Express Checkout IntegrationSetting Up the Express Checkout Transaction438 May 2010 Express Checkout Integration Guide2. Spe

Express Checkout Integration Guide May 2010 39Implementing the Simplest Express Checkout IntegrationObtaining Express Checkout Transaction Details4NOT

Contents4 May 2010 Express Checkout Integration GuideStatic PayPal Button and Mark Images Source Requirements . . . . . . . . . . . . .

Implementing the Simplest Express Checkout IntegrationCompleting the Express Checkout Transaction440 May 2010 Express Checkout Integration GuideGetExp

Express Checkout Integration Guide May 2010 41Implementing the Simplest Express Checkout IntegrationCompleting the Express Checkout Transaction45. Exe

Implementing the Simplest Express Checkout IntegrationCompleting the Express Checkout Transaction442 May 2010 Express Checkout Integration Guide

Express Checkout Integration Guide May 2010 435Testing an Express Checkout IntegrationYou can test your Express Checkout integration in the Sandbox. T

Testing an Express Checkout Integration544 May 2010 Express Checkout Integration GuideExpress Checkout Execution FlowThe following steps match the cir

Express Checkout Integration Guide May 2010 45Testing an Express Checkout Integration5<form method=post action=https://api-3t.sandbox.paypal.com/nv

Testing an Express Checkout Integration546 May 2010 Express Checkout Integration Guidehttp://www.YourReturnURL.com/ ?token=EC-1NK66318YB717835M&Pa

Express Checkout Integration Guide May 2010 47Testing an Express Checkout Integration5<form method=post action=https://api-3t.sandbox.paypal.com/nv

Testing an Express Checkout Integration548 May 2010 Express Checkout Integration Guide

Express Checkout Integration Guide May 2010 496Customizing Express CheckoutYou can specify options in Express Checkout API requests that change the ap

Express Checkout Integration Guide May 2010 5ContentsAdding a Survey Question . . . . . . . . . . . . . . . . . . . . . . . .

Customizing Express CheckoutPayPal Review Page Order Details650 May 2010 Express Checkout Integration GuidePayPal calculates the value in the Amount (

Express Checkout Integration Guide May 2010 51Customizing Express CheckoutPayPal Review Page Order Details6PayPal Review page with order details Speci

Customizing Express CheckoutPayPal Review Page Order Details652 May 2010 Express Checkout Integration GuideContinue, the instructions are returned in

Express Checkout Integration Guide May 2010 53Customizing Express CheckoutPayPal Review Page Order Details6SetExpressCheckout Order Details Parameters

Customizing Express CheckoutPayPal Review Page Order Details654 May 2010 Express Checkout Integration GuideRequest Parameters:[requiredSecurityParamet

Express Checkout Integration Guide May 2010 55Customizing Express CheckoutPayPal Review Page Order Details6eBay-Issued IncentivesIf the buyer’s checko

Customizing Express CheckoutPayPal Review Page Order Details656 May 2010 Express Checkout Integration GuideNew Total after applying incentivesIntegrat

Express Checkout Integration Guide May 2010 57Customizing Express CheckoutPayPal Review Page Order Details6– Buyer protection programs require it– It

Customizing Express CheckoutProviding Gift Options658 May 2010 Express Checkout Integration GuideRequest Parameters:[requiredSecurityParameters] &

Express Checkout Integration Guide May 2010 59Customizing Express CheckoutProviding Gift Options6z Gift message — This feature displays a text box in

Contents6 May 2010 Express Checkout Integration GuidePost-Integration Experience . . . . . . . . . . . . . . . . . . . . . . .

Customizing Express CheckoutGetting Buyer Consent to Receive Promotional Email660 May 2010 Express Checkout Integration GuideGetting Buyer Consent to

Express Checkout Integration Guide May 2010 61Customizing Express CheckoutAdding a Survey Question6SetExpressCheckout. Provide an alphanumeric string

Customizing Express CheckoutPayPal Page Style662 May 2010 Express Checkout Integration GuideRequest Parameters[requiredSecurityParameters] &METHOD

Express Checkout Integration Guide May 2010 63Customizing Express CheckoutPayPal Page Style6z Header background colorz Page background colorFor instru

Customizing Express CheckoutPayPal Page Style664 May 2010 Express Checkout Integration Guide2. Store the URL to the image on a secure (https) server s

Express Checkout Integration Guide May 2010 65Customizing Express CheckoutPayPal Page Style6Review page with custom header imageThe following example

Customizing Express CheckoutChanging the Locale666 May 2010 Express Checkout Integration GuideResponse Parameters[successResponseFields] &TOKEN=E

Express Checkout Integration Guide May 2010 67Customizing Express CheckoutChanging the Locale6The following example sets LOCALCODE to ES (Spain). Requ

Customizing Express CheckoutHandling Shipping Addresses668 May 2010 Express Checkout Integration GuideHandling Shipping AddressesYou can specify sever

Express Checkout Integration Guide May 2010 69Customizing Express CheckoutHandling Shipping Addresses6Request Parameters[requiredSecurityParameters]

Express Checkout Integration Guide May 2010 7ContentsChapter 12 Using Other PayPal API Operations . . . . . . . . . . . . 127Issuing Refund

Customizing Express CheckoutHandling Shipping Addresses670 May 2010 Express Checkout Integration GuidePayPal review page with a required addressSuppre

Express Checkout Integration Guide May 2010 71Customizing Express CheckoutHandling Shipping Addresses6Request Parameters[requiredSecurityParameters] &

Customizing Express CheckoutHandling Shipping Addresses672 May 2010 Express Checkout Integration GuideShipping Address OverrideYou can override the bu

Express Checkout Integration Guide May 2010 73Customizing Express CheckoutAutomatically Filling Out the PayPal Login Page6PayPal review page with ship

Customizing Express CheckoutAutomatically Filling Out the PayPal Login Page674 May 2010 Express Checkout Integration GuideRequest Parameters[requiredS

Express Checkout Integration Guide May 2010 75Customizing Express CheckoutBuyer Pays on PayPal6Pre-populated PayPal Login pageBuyer Pays on PayPalIf y

Customizing Express CheckoutBuyer Pays on PayPal676 May 2010 Express Checkout Integration Guideread Pay Now. (After the buyer returns from the PayPal

Express Checkout Integration Guide May 2010 777Implementing the Instant Update APIThe Instant Update API is a callback you can use to obtain the buyer

Implementing the Instant Update APIAbout the Instant Update API778 May 2010 Express Checkout Integration Guide3. Modify the existing Express Checkout

Express Checkout Integration Guide May 2010 79Implementing the Instant Update APIAbout the Instant Update API7PayPal Review Page With Shipping Options

Contents8 May 2010 Express Checkout Integration Guide

Implementing the Instant Update APIHow the Callback Works in the Express Checkout Flow780 May 2010 Express Checkout Integration GuideHow the Callback

Express Checkout Integration Guide May 2010 81Implementing the Instant Update APIFollowing Instant Update API Best Practices74. The buyer is redirecte

Implementing the Instant Update APISetting Up the Callback782 May 2010 Express Checkout Integration GuideSetting Up the CallbackTo set up the callback

Express Checkout Integration Guide May 2010 83Implementing the Instant Update APISetting Up the Callback7GetExpressCheckoutDetails and DoExpressChecko

Implementing the Instant Update APISetting Up the Callback784 May 2010 Express Checkout Integration GuideExample PayPal Review Page When Callback Time

Express Checkout Integration Guide May 2010 85Implementing the Instant Update APIUsing the Callback7The sample code below illustrates the callback res

Implementing the Instant Update APIUsing the Callback786 May 2010 Express Checkout Integration Guide– The buyer enters a new shipping addressz Provide

Express Checkout Integration Guide May 2010 87Implementing the Instant Update APIUsing the Callback7Request Parameters:[requiredSecurityParameters] &

Implementing the Instant Update APIUsing the Callback788 May 2010 Express Checkout Integration GuideCallback RequestThe PayPal sends the parameters in

Express Checkout Integration Guide May 2010 89Implementing the Instant Update APIUsing the Callback7METHOD=CallbackResponse &OFFERINSURANCEOPTION=

Express Checkout Integration Guide May 2010 9PrefaceThis document describes Express Checkout integration. Intended AudienceThis document is intended f

Implementing the Instant Update APIUsing the Callback790 May 2010 Express Checkout Integration Guide

Express Checkout Integration Guide May 2010 918Immediate PaymentImmediate Payment ensures a buyer pays for a purchase immediately after commiting to i

Immediate PaymentAbout Immediate Payment For Third Party Checkout892 May 2010 Express Checkout Integration Guidez By design, it does not support non-i

Express Checkout Integration Guide May 2010 93Immediate PaymentIntegrating Immediate Payment for Third-Party Checkout82. In the call to the SetExpress

Immediate PaymentAbout Immediate Payment For Express Checkout894 May 2010 Express Checkout Integration GuideTo integrate Immediate Payment into the Se

Express Checkout Integration Guide May 2010 95Immediate PaymentIntegrating Immediate Payment for Express Checkout8Immediate Payment for Express Checko

Immediate PaymentIntegrating Immediate Payment for Express Checkout896 May 2010 Express Checkout Integration Guide

Express Checkout Integration Guide May 2010 979Implementing Parallel PaymentsNot only can Express Checkout support payment between a single buyer and

Implementing Parallel PaymentsAbout Parallel Payments998 May 2010 Express Checkout Integration GuidePost-Integration ExperienceAfter you integrate par

Express Checkout Integration Guide May 2010 99Implementing Parallel PaymentsName-Value Pair Syntax Supporting Parallel Payments9Name-Value Pair Syntax