Developer's Guide

Preapproval API Operation
PreapprovalRequest Message
168 August 7, 2012 Adaptive Payments Developer Guide
paymentPeriod xs:string
(Optional) The payment period. It is one of the following values:
 NO_PERIOD_SPECIFIED
 DAILY – Each day
 WEEKLY – Each week
 BIWEEKLY – Every other week
 SEMIMONTHLY – Twice a month
 MONTHLY – Each month
 ANNUALLY – Each year
pinType xs:string
(Optional) Whether a personal identification number (PIN) is required. It is
one of the following values:
 NOT_REQUIRED – A PIN is not required (default)
 REQUIRED – A PIN is required; the sender must specify a PIN when
setting up the preapproval on PayPal
requestEnvelope common:RequestEnvelope
(Required) Information common to each API operation, 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 the
sender approves the preapproval on paypal.com.
Maximum length: 1024 characters
senderEmail xs:string
(Optional) Sender’s email address. If not specified, the email address of the
sender who logs in to approve the request becomes the email address
associated with the preapproval key.
Maximum length: 127 characters
startingDate xs:dateTime
(Required) First date for which the preapproval is valid. It cannot be before
today’s date or after the ending date.
displayMaxTotalAmount xs:boolean
(Optional) Whether to display the maximum total amount of this preapproval.
It is one of the following values:
 TRUE – Display the amount
 FALSE – Do not display the amount (default)
Field Description