2009

Name-Value Pair API Developer Guide 08 April 2009 101
Recurring Payments and Reference Transactions API Operations
CreateRecurringPaymentsProfile API
Activation Details Type
Ship To Address Fields
Field Description
INITAMT (Optional) Initial non-recurring payment amount due immediately upon profile
creation. Use an initial amount for enrolment or set-up fees.
NOTE: All amounts included in the request must have the same currency.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
FAILEDINITAMTACTION (Optional) By default, PayPal will suspend the pending profile in the event that the
initial payment amount fails. You can override this default behavior by setting this
field to ContinueOnFailure, which indicates that if the initial payment amount
fails, PayPal should add the failed payment amount to the outstanding balance for this
recurring payment profile.
When this flag is set to ContinueOnFailure, a success code will be returned to the
merchant in the CreateRecurringPaymentsProfile response and the recurring
payments profile will be activated for scheduled billing immediately. You should
check your IPN messages or PayPal account for updates of the payment status.
If this field is not set or is set to CancelOnFailure, PayPal will create the recurring
payment profile, but will place it into a pending status until the initial payment is
completed. If the initial payment clears, PayPal will notify you by IPN that the
pending profile has been activated. If the payment fails, PayPal will notify you by
IPN that the pending profile has been canceled.
Character length and limitations: ContinueOnFailure or CancelOnFailure.
Field Description
SHIPTONAME Person’s name associated with this address. This field is required for
shipping addresses but is optional for credit card billing addresses.
Character length and limitations: 32 single-byte characters.
SHIPTOSTREET First street address. This field is required if the shipping address is used.
Character length and limitations: 100 single-byte characters.
SHIPTOSTREET2 (Optional) Second street address.
Character length and limitations: 100 single-byte characters.
SHIPTOCITY Name of city. This field is required if the shipping address is used.
Character length and limitations: 40 single-byte characters.
SHIPTOSTATE State or province. This field is required if the shipping address is used.
Character length and limitations: 40 single-byte characters.
SHIPTOZIP U.S. ZIP code or other country-specific postal code. This field is required if
a U.S. shipping address is used and may be required for other countries.
Character length and limitations: 20 single-byte characters.