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.8.0 Features
264 August 7, 2012 Adaptive Payments Developer Guide
Changes to ConvertCurrencyRequest Fields for Version 1.8.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.
New JavaScript Function for Version 1.8.0: AutoRedirectOnDone
After the payment sender using a Merchant site completes a transaction, the Thank you for
using PayPal page appears, also known as the “Done” page. Previously, from within this
page, the Merchant allowed the sender to close the page or to navigate back to a Merchant-
specified URL by clicking a button. Now, by using the AutoRedirectOnDone option, the
Merchant can automatically redirect the sender from the Thank you for using PayPal page to
a specified URL, which opens after a waiting period of about five seconds.
The following code sample shows how this optional function would be implemented in a
minibrowser, a lightbox, or an iframe.
NOTE: Do not supply a value for autoredirectondone. Be aware that you do not
necessarily have to use the button images provided in the sample code.
Field Description
conversionType xs:string
(Optional) The conversion type allows you to determine the converted
amounts for a PayPal user in different currency conversion scenarios. Possible
values are:
SENDER_SIDE – Pass this conversion type when you convert amounts for
a PayPal user who is sending a payment in a different currency from what
he/she holds in PayPal.
RECEIVER_SIDE – Pass this conversion type when you when you convert
amounts for a PayPal user who is accepting a payment in a currency that
he/she does not hold and who wants to convert the received payment.
BALANCE_TRANSFER – Pass this conversion type when you convert
amounts for a PayPal user who is converting a balance in one currency to a
balance in a different currency on his/her profile.
countryCode xs:string
(Optional)The two-character ISO code for the country where the function is
supposed to happen. The default value is US.
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