Integration Guide
Table Of Contents
- PayPal Payments Pro Integration Guide
- Contents
- Preface
- Introducing PayPal Payments Pro
- Introducing Direct Payment
- Introducing Express Checkout
- Getting Started With Direct Payment
- Getting Started With Express Checkout
- Integrating Recurring Payments
- How Recurring Payments Work
- Recurring Payments Terms
- Recurring Payments With Direct Payment
- Recurring Payments With the Express Checkout API
- Options for Creating a Recurring Payments Profile
- Recurring Payments Profile Status
- Getting Recurring Payments Profile Information
- Modifying a Recurring Payments Profile
- Billing the Outstanding Amount of a Profile
- Recurring Payments Notifications
- Getting Started With the PayPal Name-Value Pair API
- Implementing 3-D Secure Transactions (UK Only)
Integrating Recurring Payments
Getting Recurring Payments Profile Information
6
70 April 2012 PayPal Payments Pro Integration Guide
CancelOnFailure in the CreateRecurringPaymentsProfile request, PayPal creates
the profile with a status of PendingProfile. The profile remains in this status until the
initial payment either completes successfully or fails.
A profile has a status of ExpiredProfile when PayPal completes the total billing cycles for
the optional trial and the regular payment periods.
You can suspend or cancel a profile by using the
ManageRecurringPaymentsProfileStatus API. You can also reactivate a suspended
profile. If PayPal has already reached the maximum number of failed payments, however, you
must increase the number of failed payments before reactivating the profile.
NOTE: You can also suspend, cancel, or reactive a recurring payments profile through the
PayPal website.
For recurring payments profiles created with the Express Checkout API, the buyer receives an
email about the change in status of their recurring payment.
Getting Recurring Payments Profile Information
Use the GetRecurringPaymentsProfileDetails API to obtain information about a
profile.
NOTE: You can also get information about recurring payments profiles from the PayPal
website.
Along with the information that you specified in the CreateRecurringPaymentsProfile
request, GetRecurringPaymentsProfileDetails also returns the following summary
information about the profile:
Profile status
Next scheduled billing date
Number of billing cycles completed in the active subscription period
Number of billing cycles remaining in the active subscription period
Current outstanding balance
Total number of failed billing cycles
Date of the last successful payment received
Amount of the last successful payment received
Modifying a Recurring Payments Profile
Use the UpdateRecurringPaymentsProfile API to modify a recurring payments profile.
NOTE: You can also modify recurring payments profiles from the PayPal website.