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
1.6.0 Features
266 August 7, 2012 Adaptive Payments Developer Guide
New API Operations for Version 1.7.0
Changes to ConfirmPreapprovalRequest Fields for Version 1.7.0
Changes to JavaScript Functions for Embedded Payments
You must include https://www.paypalobjects.com/js/external/dg.js for a
lightbox or https://www.paypalobjects.com/js/external/apdg.js for a
minibrowser on any page that invokes or terminates the embedded payment flow.
1.6.0 Features
Version 1.6.0 of the Adaptive Payments API introduces new API operations, as well as
changes to several Adaptive Payments API operations and additional error messages.
NOTE: Changes to API operations are backward-compatible.
New API Operations for Version 1.6.0
API Operation Description
GetAllowedFundingSources Determines the funding sources associated with a preapproval.
Field Description
fundingSourceId New field:
xs:string
(Optional) Funding source ID.
Function and Signature Description
PAYPAL.apps.D GFlow = function
(trigger: null, expType: null)
New expType:
mini requests that the embedded payment flow displays in a
minibrowser
API Operation Description
GetFundingPlans Determines the funding sources that are available for a specified
payment
GetShippingAddresses Obtains the selected shipping address
GetAvailableShippingAddresses Obtains available shipping addresses