Developer's Guide
Table Of Contents
- Adaptive Payments Developer Guide
- Contents
- What’s New?
- Introducing Adaptive Payments
- Adaptive Payments Actors and Objects
- Simple, Parallel, and Chained Payments
- Payment Approval
- Adaptive Payments Service Permissions
- Explicit Approval Payment Flow
- Preapproved Payments Flow
- Implicit Approval Payments Flow
- Embedded Payments
- Embedded Payment Flow Presentations
- Kinds of Embedded Payments
- Embedded Payments Implementation Basics
- Embedded Payment Experience
- Preapprove Future Payments Checkbox
- Shipping Address Information
- Embedded Payment Experience
- Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Lightbox
- Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Minibrowser
- Displaying and Collecting Shipping Addresses
- Guest Payments
- Fee Payment Configuration
- Getting Started
- Pay API Operation
- PaymentDetails API Operation
- ExecutePayment API Operation
- GetPaymentOptions API Operation
- SetPaymentOptions API Operation
- Preapproval API Operation
- PreapprovalDetails API Operation
- CancelPreapproval API Operation
- ConvertCurrency API Operation
- Refund API Operation
- GetFundingPlans API Operation
- GetShippingAddresses API Operation
- Adaptive Payment Commands and Redirects
- Instant Payment Notifications
- Older Versions of the Adaptive Payments API
- 1.8.0 Features
- 1.7.0 Features
- 1.6.0 Features
- New API Operations for Version 1.6.0
- Changes to PayRequest Fields for Version 1.6.0
- Changes to PayResponse Fields for Version 1.6.0
- Changes to ExecutePaymentRequest Fields for Version 1.6.0
- Changes to GetPaymentOptionsResponse Fields for Version 1.6.0
- Changes to SetPaymentOptionsRequest Fields for Version 1.6.0
- Changes to PreapprovalRequest Fields for Version 1.6.0
- Changes to Address Structure for Version 1.6.0
- Changes to DisplayOptions Structure for Version 1.6.0
- New CurrencyConversion Structure for Version 1.6.0
- New InvoiceData Structure for Version 1.6.0
- New InvoiceItem Structure for Version 1.6.0
- New SenderOptions Structure for Version 1.6.0
- New SenderIdentifier Structure for Version 1.6.0
- New AccountIdentifier Structure for Version 1.6.0
- New ReceiverOptions Structure for Version 1.6.0
- New ReceiverIdentifier Structure for Version 1.6.0
- Additional Error Messages for Version 1.6.0
- 1.5.0 Features
- 1.4.0 Features
- 1.3.0 Features
- 1.2.0 Features
- 1.1.0 Features
- Revision History
- Index
Adaptive Payment Commands and Redirects
Embedded Payment Flow Redirect
254 August 7, 2012 Adaptive Payments Developer Guide
_ap-preapproval Command
The sender can log in to paypal.com and approve a preapproval request when you redirect the
sender’s browser to PayPal using the _ap-preapproval command.
Redirect to PayPal using the _ap-preapproval command
https://www.paypal.com/webscr?cmd=_ap-preapproval&preapprovalkey=value
Response to _ap-preapproval command from PayPal
PayPal redirects to the return URL you set in the Preapproval request.
NOTE: Any additional parameters you specify in the URL are not returned.
Embedded Payment Flow Redirect
The sender of a payment can log in to paypal.com and approve a payment using the embedded
payment flow. Your web pages must use PayPal-provided JavaScript to launch the flow.
Redirect to PayPal
https://www.paypal.com/webapps/adaptivepayment/flow/pay?
paykey=value&preapprovalkey=value
Response from PayPal
PayPal redirects to the return URL you set in the Pay request.
NOTE: Any additional parameters you specify in the URL are not returned.
Parameter Description
cmd (Required) _ap-preapproval
preapprovalkey (Required) The preapproval key from the Preapproval response message; for
example, PA-12345678901234567.
Parameter Description
paykey (Required) The payment key from the Pay response message; for example, AP-
12345678901234567.
preapprovalkey (Optional) The preapproval key from the Preapproval response message,
which enables the Preapprove future payments option; for example, PA-
12345678901234567.