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 281
1.3.0 Features
Changes to the Pay API Operation for Version 1.3.0
Changes to PayRequest Message
Field Description
ClientDetails.applicationId This field is no longer required. The application ID is passed in
a new HTTP header. For information, refer to the Specifying
Application and Device Information section.
ClientDetails.ipAddress This field is no longer required.
fundingConstraint New field:
ap:FundingConstraint
Specifies a list of allowed funding types for the payment. This
list can be in any order. If this field is omitted, the payment can
be funded by any funding type that is supported by Adaptive
Payments.
NOTE: This feature is available for applications with special
permission level.
FundingTypeList.fundingTypeInfo New field:
ap:FundingTypeInfo
Specifies a list of allowed funding types for the payment. This
list can be in any order. If this field is omitted, the payment can
be funded by any funding type that is supported by Adaptive
Payments.
NOTE: This feature is available for applications with special
permission level.
fundingType New field:
xs:string
Specifies the allowed funding types that can be used as
funding sources for the payment.
Allowable values are:
ECHECK – Electronic check
BALANCE – PayPal account balance
CREDITCARD – Credit card
NOTE: This feature is available for applications with special
permission level.
logdefaultShippingAddress This field has been removed. Pay requests that use this field
are executed, but the logdefaultShippingAddress is
ignored.
Receiver.paymentType New field:
xs:string
The transaction subtype for the payment. Allowable values
are:
GOODS – This is a payment for goods
SERVICE – This is a payment for services (default)