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
PreapprovalDetails API Operation
PreapprovalDetailsResponse Message
182 August 7, 2012 Adaptive Payments Developer Guide
dayOfWeek The day of the week that a weekly payment is to be made. Possible values are:
NO_DAY_SPECIFIED
SUNDAY
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
endingDate Last date for which the preapproval is valid. Time is currently not supported.
NOTE: You must specify a value unless you have specific permission from
PayPal to omit this value.
ipnNotificationUrl The URL to which all IPN messages for this preapproval are sent.
maxAmountPerPayment The preapproved maximum amount per payment.
maxNumberOfPayments The preapproved maximum number of payments. This field is only returned if
provided.
maxNumberOfPaymentsPerPe
riod
The preapproved maximum number of payments per period.
maxTotalAmountOfAllPayme
nts
The preapproved maximum total amount of all payments.
NOTE: You must specify a value unless you have specific permission from
PayPal to omit this value.
memo A note about the preapproval.
paymentPeriod The payment period. Possible values are:
NO_PERIOD_SPECIFIED
DAILY
WEEKLY
BIWEEKLY
SEMIMONTHLY
MONTHLY
ANNUALLY
pinType Whether a personal identification number (PIN) is required. It is one of the
following values:
NOT_REQUIRED – A PIN is not required
REQUIRED – A PIN is required
responseEnvelope Common response information, including a timestamp and the
acknowledgement status.
returnUrl The URL to which the sender’s browser is redirected after the sender approves
the preapproval on paypal.com. Use the preapproval key to identify the
preapproval as follows: preapprovalKey=${preapprovalKey}.
Field Description