Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 167
Preapproval API Operation
PreapprovalRequest Message
dayOfWeek common:DayOfWeek
(Optional) The day of the week that a weekly payment is to be made.
Allowable values are:
 NO_DAY_SPECIFIED
 SUNDAY
 MONDAY
 TUESDAY
 WEDNESDAY
 THURSDAY
 FRIDAY
 SATURDAY
endingDate xs:dateTime
(Optional) Last date for which the preapproval is valid. It cannot be later than
one year from the starting date.
NOTE: You must specify a value unless you have specific permission from
PayPal to omit this value.
ipnNotificationUrl xs:string
(Optional) The URL to which you want all IPN messages for this preapproval
to be sent. This URL supersedes the IPN notification URL in your profile.
Maximum length: 1024 characters
maxAmountPerPayment xs:decimal
(Optional) The preapproved maximum amount per payment. It cannot exceed
the preapproved maximum total amount of all payments.
maxNumberOfPayments xs:int
(Optional) The preapproved maximum number of payments. It cannot exceed
the preapproved maximum total number of all payments.
maxNumberOfPaymentsPerPe
riod
xs:int
(Optional) The preapproved maximum number of all payments per period.
You must specify a value unless you have specific permission from PayPal.
maxTotalAmountOfAllPayme
nts
xs:decimal
(Optional) The preapproved maximum total amount of all payments. It cannot
exceed $2,000 USD or its equivalent in other currencies.
NOTE: You must specify a value unless you have specific permission from
PayPal to omit this value.
memo xs:string
(Optional) A note about the preapproval.
Maximum length: 1000 characters, including newline characters
Field Description