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 81
Pay API Operation
PayRequest Message
fundingConstraint ap:FundingConstraint
(Optional) Specifies a list of allowed funding types for the payment. This is a
list of funding selections that can be combined in any order to allow payments
to use the indicated funding type. If this Parameter is omitted, the payment can
be funded by any funding type that is supported for Adaptive Payments.
NOTE: FundingConstraint is unavailable to API callers with standard
permission levels; for more information, refer to the section Adaptive
Payments Permission Levels.
ipnNotificationUrl xs:string
(Optional) The URL to which you want all IPN messages for this payment to
be sent.
Maximum length: 1024 characters
memo xs:string
(Optional) A note associated with the payment (text, not HTML).
Maximum length: 1000 characters, including newline characters
pin xs:string
(Optional) The sender’s personal identification number, which was specified
when the sender signed up for a preapproval.
preapprovalKey xs:string
(Optional) The key associated with a preapproval for this payment. The
preapproval key is required if this is a preapproved payment.
NOTE: The Preapproval API is unavailable to API callers with Standard
permission levels.
receiverList ap:ReceiverList
(Required) Information about the receivers of the payment.
requestenvelope common:RequestEnvelope
(Required) Information common to each Method, such as the language in
which an error message is returned.
returnUrl xs:string
(Required) The URL to which the sender’s browser is redirected after
approving a payment on paypal.com. Specify the URL with the HTTP or
HTTPS designator.
Maximum length: 1024 characters
reverseAllParallelPaymen
tsOnError
xs:boolean
(Optional) Whether to reverse parallel payments if an error occurs with a
payment.
Allowable values are:
true – Each parallel payment is reversed if an error occurs
false – Only incomplete payments are reversed (default)
Field Description