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 Payments Developer Guide August 7, 2012 265
1.7.0 Features
Minibrowser code
<form id="mini-form"
action="https://www.paypal.com/webapps/adaptivepayment/flow/pay"
target="PPDGFrame">
<br><fieldset>
<b><legend>Pay - Mini Browser</legend></b>
<input id="type" name="expType" value="mini" type="hidden">
<input id="type" name="autoredirectondone" type="hidden">
<label for="paykey">PayKey</label>
<input id="paykey" name="payKey" size="25" type="text">
<input type="image" id="miniBrowserBtn"
value="Pay with PayPal mini"
src="https://www.paypal.com/en_US/i/btn/
x-click-but06.gif">
</fieldset>
</form>
Lightbox code
<form id="lightbox-form"
action="https://www.paypal.com/webapps/adaptivepayment/flow/pay"
target="PPDGFrame">
<fieldset>
<b><legend>Pay - Lightbox</legend></b>
<input id="type" name="expType" value="lightbox" type="hidden">
<input id="type" name="autoredirectondone" type="hidden">
<label for="paykey">PayKey</label>
<input id="paykey" name="payKey" size="25" type="text">
<input type="submit" id="submitBtn" value="Pay with light"
src="https://www.paypal.com/en_US/i/btn/x-click-but06.gif">
</fieldset>
</form>
iFrame Code
<iframe id="PPDGFrame" name="PPDGFrame"
src="https://www.paypal.com/webapps/adaptivepayment/flow
/pay?expType=light&paykey=AP-SAMPLEPAYKEY&autoredirectondone=
"scrolling="no" frameborder="0" style="border: none; height: 550px;
width: 385px;" allowtransparency="true"> </iframe>
1.7.0 Features
Version 1.7.0 of the Adaptive Payments API introduces a new API operation and changes
several Adaptive Payments API operations for mobile providers.
NOTE: Changes to API operations are backward-compatible.