Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 163
8
Preapproval API Operation
Use the Preapproval API operation to set up an agreement between yourself and a sender
for making payments on the sender’s behalf.
You set up a preapprovals for a specific maximum amount over a specific period of time and,
optionally, by any of the following constraints: the number of payments, a maximum per-
payment amount, a specific day of the week or the month, and whether or not a PIN is required
for each payment request.
Preapproval Overview
To set up a preapproval request, you must specify values for the following fields:
Required preapproval fields
Preapproval Notifications
Notifications are sent after preapproval is complete:
Field Description
endingDate Last date for which the preapproval is valid. It cannot be
later than one year from the starting date. Contact PayPal if
you do not want to specify an ending date.
startingDate First date for which the preapproval is valid. It cannot be
before today’s date or after the ending date.
maxTotalAmountOfAllPayments The preapproved maximum total amount of all payments. It
cannot exceed $2,000 USD or its equivalent in other
currencies. Contact PayPal if you do not want to specify a
maximum amount.
currencyCode The code for the currency in which the payment is made;
you can specify only one currency, regardless of the number
of receivers
cancelUrl URL to redirect the sender’s browser to after canceling the
preapproval
returnUrl URL to redirect the sender’s browser to after the sender has
logged into PayPal and confirmed the preapproval
requestEnvelope.errorLanguage The code for the language in which errors are returned,
which must be en_US.