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 3
Contents
What’s New?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
1.8.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
SenderIdentifier Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
TaxIdDetails Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 1 Introducing Adaptive Payments . . . . . . . . . . . . . . .17
Adaptive Payments Actors and Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Simple, Parallel, and Chained Payments . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Simple Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Parallel Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Chained Payments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Payment Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Adaptive Payments Service Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Explicit Approval Payment Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Preapproved Payments Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Implicit Approval Payments Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Embedded Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Embedded Payment Flow Presentations . . . . . . . . . . . . . . . . . . . . . . . . 28
Kinds of Embedded Payments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Embedded Payments Implementation Basics . . . . . . . . . . . . . . . . . . . . . . 31
Embedded Payment Experience . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Preapprove Future Payments Checkbox . . . . . . . . . . . . . . . . . . . . . . . . 37
Shipping Address Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Embedded Payment Experience . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Lightbox . . . 55
Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Minibrowser . 57
Displaying and Collecting Shipping Addresses . . . . . . . . . . . . . . . . . . . . . 58
Guest Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Fee Payment Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Sender Pays the Fee . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Receiver Pays the Fee in a Parallel Payment . . . . . . . . . . . . . . . . . . . . . . 62
Each Receiver Pays the Fee in a Chained Payment . . . . . . . . . . . . . . . . . . 62
Primary Receiver Pays the Fee in a Chained Payment . . . . . . . . . . . . . . . . . 63