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
GetPaymentOptions API Operation
GetPaymentOptionsResponse Message
142 August 7, 2012 Adaptive Payments Developer Guide
DisplayOptions Fields
DisplayOptions fields allow the API caller to provide PayPal with a link to an image.
displayOptions ap:DisplayOptions
Specifies display items in payment flows and emails.
initiatingEntitity ap:InitiatingEntity
The PayPal financial partner that is initiating the payment. Financial partners
must first be set up in the Admin tool before they can use the PayPal APIs.
shippingAddressId xs:string
Sender’s shipping address ID.
senderOptions ap:SenderOptions
Specifies information to be provided by the sender.
receiverOptions ap:ReceiverOptions
Specifies information about each receiver.
requestEnvelope common:requestEnvelope
Information common to each API operation, such as the language in which an
error message is returned.
Field Description
emailHeaderImageUrl xs:string
The URL of the image that displays in the in the header of customer emails.
The image dimensions are 43 pixels high x 240 pixels wide.
emailMarketingImageUrl xs:string
The URL of the image that displays in the in customer emails. The image
dimensions are 80 pixels high x 530 pixels wide.
headerImageUrl xs:string
The URL of the image that displays in the header of a payment page. Use this
to configure payment flows by passing a different image URL for different
scenarios. If set, it overrides the header image URL specified in your account’s
Profile. The image dimensions are 90 pixels high x 750 pixels wide.
NOTE: The headerImageUrl and businessName parameters are mutually
exclusive; only one of these fields can be used. If you specify both, the
image will take precedence over the business name.
businessName xs:string
The business name to display.
NOTE: The headerImageUrl and businessName parameters are mutually
exclusive; only one of these fields can be used. If you specify both, the
image will take precedence over the business name.
Field Description