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 289
1.1.0 Features
Changes to Preapproval API Operation for Version 1.1.0
Changes to PreapprovalRequest message
New Preapproval error messages
Changes to PreapprovalDetails API Operation for Version 1.1.0
Changes to PreapprovalDetailsResponse message
New PreapprovalDetails error messages
Changes to Refund API Operation for Version 1.1.0
Field Description
maxNumberOfPayments This field is now optional; it is no longer required.
senderEmail This field is now optional; it is no longer required. If not specified, the email
address of the sender who logs in to approve the request becomes the email
address associated with the preapproval key.
clientDetails.deviceId This field is now optional; it is no longer required.
Code Message Additional Information
580022 Invalid request: ~1 Invalid request parameter; for
example an invalid application
ID or language code
580029 Invalid request: ~1 Missing request parameter
Field Description
senderEmail The sender’s email address is only available when you explicitly set the email
address in the PreapprovalRequest message.
maxNumberOfPayments The preapproved maximum number of payments is only available when you
explicitly set the email address in the PreapprovalRequest message.
Code Message Additional Information
540031 You do not have permission to get the details of this Preapproval
580022 Invalid request: ~1 Invalid request parameter; for
example an invalid application
ID or language code
580029 Invalid request: ~1 Missing request parameter