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 75
Pay API Operation
Pay Summary
Implicit Payments
If you are the API caller and you specify your email address in the senderEmail field,
PayPal implicitly approves the payment without redirecting to PayPal:
Preapproved Payments
If the sender has set up a preapproval, you can use the preapproval to avoid explicit approval.
In that case, you must specify values for the fields below.
Payments for Digital Goods
You handle payments for digital goods in the same way you handle payments for other goods
and services, with the following exceptions:
To specify a payment for digital goods, you must specify DIGITALGOODS for each receiver
in your receiver list; specify
receiverList.receiver(
n).paymentType=DIGITALGOODS for each receiver,
where
n identifies the receiver, starting with 0.
If you specify a payment for digital goods, you cannot specify a senderEmail address or
include a funding constraint.
You must redirect the sender to the following PayPal URL to complete the payment for
digital goods:
https://www.paypal.com/webapps/adaptivepayment/flow/pay?paykey=...
Payment Notifications
Notifications are sent after payment is executed, which follows approval of the payment by the
sender if required:
PayPal sends an email to the sender and all receivers associated with a payment when the
transfer is complete; you receive an email only if you are also the payment sender or
receiver.
Field Description
senderEmail Sender’s email address
Field Description
preapprovalKey Preapproval key for the approval set up between you and the
sender
pin Sender’s personal identification number, if one was
specified when the sender agreed to the approval