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 279
1.3.0 Features
Changes to the Refund API Operation
Changes to RefundRequest and RefundResponse Message
1.3.0 Features
Version 1.3.0 includes changes to existing APIs as well new APIs: ConvertCurrency,
CancelPreapproval. It also includes the new PPFaultMessage.
Overview of Changes for Version 1.3.0
These are the main changes for version 1.3.0:
Consumer signups for new PayPal accounts
Consumers can now sign up for a PayPal account during the payment preapproval web
flow. Consumers can also sign up for a PayPal account during a payment web flow and
then complete the payment in the same session.
Preapproval cancellations
This release includes a new API operation to allow consumers to cancel preapprovals: the
CancelPreapproval API operation. In past releases, consumers could only cancel
preapprovals through paypal.com. For more information, refer to the CancelPreapproval
API Operation section.
Getting Foreign Exchange rates for a list of payment amounts
This release provides a new API Operation, ConvertCurrency, that lets you convert a
given amount in one currency to an equivalent amount in another currency based on the
BaseAddress.state xs:string
The state for the billing address
BaseAddress.type xs:string
The type of billing address. Possible values are:
BILLING – This is a billing address
Field Description
Receiver.PhoneNumberType New field:
common:PhoneNumberType
Allows you to pass a receiver’s phone number, including the
country code and extension.
NOTE: This feature is available for applications with special
permission level.
Field Description